Creating JSDoc Comments
To enable JSDoc comments
- In the Settings/Preferences dialog (Ctrl+Alt+S), click General under Editor, and then click Smart Keys. The Smart Keys page opens.
- 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.