Manage documentation comments

Last modified: 21 July 2022

warning

Note that this section refers to Python, JavaScript, and the other languages that have special beginning of documentation comments.

Enable documentation comments

  1. Press Ctrl+Alt+S to open the IDE settings and select Editor | General | Smart Keys.

  2. In the Enter section, select or clear Insert documentation comment stub checkbox.

  3. Then, expand the Smart Keys node and select Python. Use the Insert type placeholders in the documentation comment stub option as required.

    If this checkbox is selected, PyCharm generates a documentation comment stub.

Disable documentation comments

  1. To restrict creating documentation comments, press Ctrl+Alt+S to open the IDE settings and select Tools | Python Integrated Tools.

  2. In the Docstrings area, select Plain from the Docstring format list. Click OK to save the changes.

See also

Procedures

Reference