What is the proper way to comment functions in Python?

Question

Is there a generally accepted way to comment functions in Python? Is the following acceptable?

#########################################################
# Create         


        

Answer 1

The correct way to do it is to provide a docstring. That way, help(add) will also spit out your comment.

def add(self):
    """Create a new user.
    Line 2 of comment...
    And so on... 
    """

That's three double quotes to open the comment and another three double quotes to end it. You can also use any valid Python string. It doesn't need to be multiline and double quotes can be replaced by single quotes.

See: PEP 257