JSDoc comments

Last modified: 26 May 2021

Professional feature: download PyCharm Professional to try.

PyCharm recognizes JSDoc comments and helps you create them by automatically inserting @param, @returns, @private, and other tags when you type the opening block comment /** and press Enter. JSDoc comments are used for documentation lookup with Ctrl+Q in JavaScript and TypeScript, see JavaScript documentation look-up and TypeScript documentation look-up for details.

PyCharm also recognizes TODO patterns and Closure Compiler annotations inside documentation comments and uses them in code completion, intention actions, and other types of coding assistance.

Find a detailed description of the JSDoc syntax with examples in Getting Started with JSDoc.