WebStorm
 
Get WebStorm
You are viewing the documentation for an earlier version of WebStorm.

Viewing Inline Documentation

Last modified: 21 July 2022

Available for: C/C++, Rust, Objective-C/C++, and other supported languages and CMake scripts.

Invoke: on hover or Ctrl+Q

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. See JavaScript documentation look-up and TypeScript documentation look-up for details.

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, position the caret before the declaration of the method/function or field to document, type the opening block comment /**, and press Enter. See JSDoc comments for details.

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

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/Preferences dialog.