IntelliJ IDEA 2019.1 Help

Creating JSDoc Comments

IntelliJ IDEA helps you create JSDoc comments and uses them for JavaScript Documentation Lookup with Ctrl+Q.IntelliJ IDEA 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), go to Editor | General | Smart Keys.

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

To create a JSDoc comment

  • Position the caret 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, and so on.

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

Last modified: 20 June 2019

See Also