PyCharm 2021.2 Help

Manage 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.

    For the function comments, this stub contains the required tags (@param tags for each parameter declared in the signature, and @return). Refer to Create documentation comments, JSDoc comments for details.

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.

Last modified: 17 August 2021