PyCharm 2018.2 Help

Creating JSDoc Comments

PyCharm helps you create JSDoc comments and uses them for JavaScript Documentation Lookup with Ctrl+Q.PyCharm recognizes TODO patterns and Closure Compiler annotations inside documentation comments and uses them in code completion, intention actions, and other types of coding assistance.

To enable JSDoc comments

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click General under Editor, and then click Smart Keys. The Smart Keys page opens.

  2. In the Enter area, select the Insert documentation comment stub checkbox.

To create a JSDoc comment

  • Place the cursor before the declaration of the method/function or field to document, type the opening block comment /**, and press Enter. Describe the listed parameters, return values, etc.

  • Alternatively, use the dedicated Fix Doc Comment action. Place the cursor at the method/function or field to document, press Ctrl+Shift+A, select Fix Doc String from the list, and press Enter.

Last modified: 12 October 2018

See Also