Home/ Questions/Q 637599
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-13T20:38:28+00:00

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

  • 0

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

#########################################################
# Create a new user
#########################################################
def add(self):
Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    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

    • 0