CLion 2022.1 Help

JavaScript documentation look-up

CLion shows you reference for standard JavaScript APIs, for symbols from your project and from its dependencies, as well as for symbols defined in external libraries. You can view the documentation for symbols in the Documentation popup, get information on method parameters, and open documentation on external sites if links to them are available.

  • For a project symbol or for a symbol from the project dependencies, CLion generates the documentation from the corresponding JSDoc comment.

  • For a standard JavaScript object or method, CLion shows the corresponding JSDoc comment from the built-in TypeScript definition files d.ts. These files are bundled with CLion and updated on a regular basis.

  • If no comment is found in the d.ts files, CLion shows a summary from the corresponding MDN article.

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

Quick Documentation in a popup

  • Hover the mouse over the necessary symbol in the editor.

  • Place the caret at the symbol and press Ctrl+Q or select View | Quick Documentation from the main menu.

    Press Ctrl+Q again to open this documentation in the Documentation tool window.

  • Click the Show Options Menu icon in the popup to change the font size, display the quick documentation toolbar, or go to the source code.

Click the Show Options Menu icon in the popup to change the font size, display the quick documentation toolbar, or go to the source code.

MDN documentation for symbols

  • In the Documentation popup Ctrl+Q, click the link at the bottom:

    ws_mdn_docs.png
  • Press Shift+F1 or select View | External Documentation from the main menu.

CLion opens the MDN article in the default CLion browser.

Documentation for third-party JavaScript libraries

  1. Download the required library or framework, configure it as an external JavaScript library, and specify the link to its external documentation, see Configuring a custom third-party JavaScript library for details.

  2. Position the caret at the symbol and press Shift+F1 or choose View | External Documentation from the main menu.

Documentation for npm packages

  • In a package.json file or in a require or import statement, position the caret at the name of the package and press Ctrl+Q

    ws_quick_doc_for_npm_package.png
  • To open the documentation on the npm official website in the browser, press Shift+F1.

Last modified: 26 April 2022