PyCharm 2018.2 Help

Creating Documentation Comments

Creating documentation comments for Python functions

To create documentation comment for a Python function

  1. Place the caret after the declaration of a function you want to document.
  2. Type opening triple quotes, and press Enter, or Space.
  3. Add meaningful description of parameters and return values.

To create documentation comment for a Python function using intention action

  1. Place the caret somewhere within the function you want to document.
  2. Press Alt+Enter to show the available intention actions.
  3. Choose Insert documentation string stub:
    docstring example 2

    PyCharm generates documentation comment stub according to docstring format, selected in the Python Integrated Tools page.

Example of Python comment

Consider the following function:

def handle(self, myParam1, myParam2):

In the Python Integrated Tools page, select Epytext. Then type the opening triple quotes and press Enter or Space. PyCharm generates documentation comment stub:

''' @param self: @param myParam1: @param myParam2: @return: '''

Then select reStructuredText, type the opening triple quotes and press Enter or Space. PyCharm generates documentation comment stub:

''' :param self: :param myParam1: :param myParam2: :return: '''
Last modified: 17 September 2018

See Also