PyCharm Help

Documenting Source Code in PyCharm

PyCharm provides convenient features for creating documentation comments.

In this part:

Prerequisites

Python docstrings

Basics

In languages files, PyCharm creates stubs of documentation comments on typing the opening tag and pressing Enter.

If this feature applies to a function, PyCharm generates tags, depending on the selected docstring format:

  • For reStructuredText: :param tags for each parameter declared in the function signature, and :return tag.
  • For Epytext: @param tags for each parameter declared in the function signature, and @return tag.
So doing, the tags in reStructuredText and epytext markup are highlighted accordingly.

If configured, the documentation comment stubs can be generated with type and rtype tags.

When you create additional tags, PyCharm provides code completion that suggests the possible tag names.

Documentation comments in your source code are available for the Quick Documentation Lookup and open for review on pressing Ctrl+Q.

See Also

Last modified: 15 May 2015