- In a comment block, select the desired empty line and type @ character.
- Press Ctrl+SpaceCommand Space, or just wait for Code Completion to display the suggestion list:
- Select a tag from the suggestion list. For example, you can specify the parameters type, or return type.
- If a certain tag has several values, press Ctrl+SpaceCommand Space after the tag, and select
the desired value from the suggestion list. For example, WebStorm suggests to select the desired parameter name.
Tip
Documentation comment can be created with the dedicated action Fix Doc Comment. It can be invoked by means of Find Action command.
Press Ctrl+Shift+ACtrl+Shift+A, with the caret somewhere within a class, method, function, or field, which should be documented, and enter the action name Fix Doc String. The missing documentation stub with the corresponding tags is added. For example:
The next case lays with fixing problems in the existing documentation comments.
Note that the action has no keyboard shortcut bound with it. You can do it as described in the section Configuring Keyboard Shortcuts.
