CLion 2018.1 Help

JavaScript Documentation Look-Up

CLion lets you get reference for standard JavaScript APIs, for symbols from your project and from its dependencies, as well as for symbols defined in external libraries. For npm packages, CLion shows their readme files when you invoke documentation look-up from require or import statements or from package.json files. The documentation is shown in a Documentation pop-up window that helps navigate to the related symbols via hyperlinks, and provides a toolbar for moving back and forth through the already navigated pages.

To view documentation for a symbol at caret

  • Press Ctrl+Q or choose View | Quick Documentation Lookup on the main menu. The reference for the symbol is shown in the Documentation pop-up window.
    • 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.

To view the MDN documentation for a symbol at caret, do one of the following:

  • In the Documentation window (Ctrl+Q), click the link at the bottom of the window:
    ws_mdn_docs.png
  • Press Shift+F1 or choose View | External Documentation on the main menu.

To view documentation for a third-party JavaScript library

  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 cursor at the symbol in question and press Shift+F1 or choose View | External Documentation on the main menu.

To view documentation for an npm package

  • In a package.json file or in a require or import statement, position the cursor 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.

To view reference in a tool window

  • Pin the Documentation pop-up window. It turns into the Documentation tool window, with the corresponding sidebar icon and more controls.

To show documentation automatically

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click General under Editor, then click Code Completion. The Code Completion page opens.
  2. Select the Auto-display documentation checkbox and specify the elapsed time.

To change the font size of quick documentation, do one of the following:

  • Click show slider in the upper-right corner of the quick documentation window, and move the slider.
  • In the Settings/Preferences dialog (Ctrl+Alt+S), click General under Editor and select the Change font size (Zoom) with Ctrl+Mouse Wheel checkbox.
Last modified: 7 May 2018

See Also