WebStorm
 
Get WebStorm

Viewing Inline Documentation

Last modified: 31 October 2024

Quick Documentation Look-up lets you view reference for symbols from your project and from its dependencies as well as for standard JavaScript objects and methods. For more information, refer to JavaScript documentation look-up and TypeScript documentation look-up.

For a project symbol or for a symbol from the project dependencies, WebStorm generates the documentation from the corresponding JSDoc comment. To create a comment, place the caret before the declaration of the method/function or field to document, type the opening block comment /**, and press Enter. For more information, refer to JSDoc comments.

By default, documentation is shown in the Documentation popup but you can always open it in the Documentation tool window or even configure it to appear in the Documentation tool window by default.

When you explicitly invoke code completion, then quick documentation for an entry selected in the suggestion list can be displayed automatically. The behavior of quick documentation lookup is configured in the Show documentation popup in field on the Code Completion page of the Settings dialog.