Python TutorialGetting Started with PythonPython Basic SyntaxPython DatatypesPython IndentationPython Collection TypesPython Basic Input and OutputPython Built in Modules and FunctionsPython FunctionsChemPy - python packageCreating Python packagesFunctional Programming in PythonIncompatibilities moving from Python 2 to Python 3IoT Programming with Python and Raspberry PIKivy - Cross-platform Python Framework for NUI DevelopmentMutable vs Immutable (and Hashable) in PythonPyInstaller - Distributing Python CodePython *args and **kwargsPython 2to3 toolPython Abstract Base Classes (abc)Python Abstract syntax treePython Alternatives to switch statement from other languagesPython and ExcelPython Anti-PatternsPython ArcPyPython ArraysPython Asyncio ModulePython Attribute AccessPython AudioPython Binary DataPython Bitwise OperatorsPython Boolean OperatorsPython Checking Path Existence and PermissionsPython ClassesPython CLI subcommands with precise help outputPython Code blocks, execution frames, and namespacesPython Collections modulePython Comments and DocumentationPython Common PitfallsPython Commonwealth ExceptionsPython ComparisonsPython Complex mathPython concurrencyPython ConditionalsPython configparserPython Context Managers (with Statement)Python Copying dataPython CountingPython ctypesPython Data SerializationPython Data TypesPython Database AccessPython Date and TimePython Date FormattingPython DebuggingPython DecoratorsPython Defining functions with list argumentsPython DeploymentPython Deque ModulePython DescriptorPython Design PatternsPython DictionaryPython Difference between Module and PackagePython DistributionPython DjangoPython Dynamic code execution with `exec` and `eval`Python EnumPython ExceptionsPython ExponentiationPython Files & Folders I/OPython FilterPython FlaskPython Functools ModulePython Garbage CollectionPython GeneratorsPython getting start with GZipPython graph-toolPython groupby()Python hashlibPython HeapqPython Hidden FeaturesPython HTML ParsingPython HTTP ServerPython IdiomsPython ijsonPython Immutable datatypes(int, float, str, tuple and frozensets)Python Importing modulesPython Indexing and SlicingPython Input, Subset and Output External Data Files using PandasPython Introduction to RabbitMQ using AMQPStorm

Python Comments and Documentation

From WikiOD

Syntax[edit | edit source]

  • # This is a single line comment
  • print("")  # This is an inline comment
  • """

This is

a multi-line comment


Remarks[edit | edit source]

Developers should follow the PEP257 - Docstring Conventions guidelines. In some cases, style guides (such as Google Style Guide ones) or documentation rendering third-parties (such as Sphinx) may detail additional conventions for docstrings.

Programmatically accessing docstrings[edit | edit source]

Docstrings are - unlike regular comments - stored as an attribute of the function they document, meaning that you can access them programmatically.

An example function[edit | edit source]

def func():
    """This is a function that does nothing at all"""

The docstring can be accessed using the __doc__ attribute:


This is a function that does nothing at all


Help on function func in module __main__:


     This This is a function that does nothing at all

Another example function[edit | edit source]

function.__doc__ is just the actual docstring as a string, while the help function provides general information about a function, including the docstring. Here's a more helpful example:

def greet(name, greeting="Hello"):
    """Print a greeting to the user `name`

    Optional parameter `greeting` can change what they're greeted with."""

    print("{} {}".format(greeting, name))

Help on function greet in module __main__:

greet(name, greeting='Hello')

    Printrint a greeting to the user name

    Optionalonal parameter greeting can change what they're greeted with.

Advantages of docstrings over regular comments[edit | edit source]

Just putting no docstring or a regular comment in a function makes it a lot less helpful.

def greet(name, greeting="Hello"):
    # Print a greeting to the user `name`
    # Optional parameter `greeting` can change what they're greeted with.

    print("{} {}".format(greeting, name))



Help on function greet in module main:

greet(name, greeting='Hello')

Single line, inline and multiline comments[edit | edit source]

Comments are used to explain code when the basic code itself isn't clear.

Python ignores comments, and so will not execute code in there, or raise syntax errors for plain english sentences.

Single*line comments begin with the hash character (#) and are terminated by the end of line.

  • Single line comment:
# This is a single line comment in Python
  • Inline comment:
print("Hello World")  # This line prints "Hello World"
  • Comments spanning multiple lines have """ or on either end. This is the same as a multiline string, but they can be used as comments:
This type of comment spans multiple lines.
These are mostly used for documentation of functions, classes and modules.

Write documentation using docstrings[edit | edit source]

A docstring is a multi-line comment used to document modules, classes, functions and methods. It has to be the first statement of the component it describes.

def hello(name):
    """Greet someone.

    Print a greeting ("Hello") for the person with the given name.

    print("Hello "+name)
class Greeter:
    """An object used to greet people.

    It contains multiple greeting functions for several languages
    and times of the  day.

The value of the docstring can be accessed within the program and is - for example - used by the help command.

Syntax conventions[edit | edit source]

PEP 257[edit | edit source]

PEP 257 defines a syntax standard for docstring comments. It basically allows two types:

  • One-line Docstrings:

According to PEP 257, they should be used with short and simple functions. Everything is placed in one line, e.g:

def hello():
    """Say hello to your friends."""
    print("Hello my friends!")

The docstring shall end with a period, the verb should be in the imperative form.

  • Multi-line Docstrings:

Multi*line docstring should be used for longer, more complex functions, modules or classes.

def hello(name, language="en"):
    """Say hello to a person.

    name: the name of the person
    language: the language in which the person should be greeted

    print(greeting[language]+" "+name)

They start with a short summary (equivalent to the content of a one-line docstring) which can be on the same line as the quotation marks or on the next line, give additional detail and list parameters and return values.

Note PEP 257 defines what information should be given within a docstring, it doesn't define in which format it should be given. This was the reason for other parties and documentation parsing tools to specify their own standards for documentation, some of which are listed below and in this question.

Sphinx[edit | edit source]

Sphinx is a tool to generate HTML based documentation for Python projects based on docstrings. Its markup language used is reStructuredText. They define their own standards for documentation, hosts a very good description of them. The Sphinx format is for example used by the pyCharm IDE.

A function would be documented like this using the Sphinx/reStructuredText format:

def hello(name, language="en"):
    """Say hello to a person.

    :param name: the name of the person
    :type name: str
    :param language: the language in which the person should be greeted
    :type language: str
    :return: a number
    :rtype: int

    print(greeting[language]+" "+name)
    return 4

Google Python Style Guide[edit | edit source]

Google has published Google Python Style Guide which defines coding conventions for Python, including documentation comments. In comparison to the Sphinx/reST many people say that documentation according to Google's guidelines is better human-readable.

The page mentioned above also provides some examples for good documentation according to the Google Style Guide.

Using the Napoleon plugin, Sphinx can also parse documentation in the Google Style Guide-compliant format.

A function would be documented like this using the Google Style Guide format:

def hello(name, language="en"):
    """Say hello to a person.

        name: the name of the person as string
        language: the language code string

        A number.

    print(greeting[language]+" "+name)
    return 4