How to add JSDoc comments to CommonJS and Node.js modules.

JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself.

The parameter type can be a built-in JavaScript type, such as string or Object, or a JSDoc namepath to another symbol in your code. If you have written documentation for the symbol at …

@use JSDoc Overview Provide an example of how to use a documented item. The text that follows this tag will be displayed as highlighted code. Examples Note that a doclet may have …

You can use any Google Closure Compiler type expression, as well as several other formats that are specific to JSDoc. If JSDoc determines that a type expression is invalid, it will display an …

JSDoc 3 makes it easy to document classes that follow the ECMAScript 2015 specification. You don't need to use tags such as @class and @constructor with ES 2015 classes—JSDoc …

JSDoc allows you to include tutorials alongside your API documentation. You can use this feature to provide detailed instructions for using your API, such as a "getting started" guide or a step-by …

To run JSDoc with a configuration file, use the -c command-line option (for example, jsdoc -c /path/to/conf.json or jsdoc -c /path/to/conf.js). The following examples show a simple …

Most JSDoc tags are block tags. In general, when this site refers to "JSDoc tags," we really mean "block tags." Examples In the following example, @param is a block tag, and {@link} is an inline …

Document the return value of a function.Synonyms return Syntax @returns [{type}] [description] Overview The @returns tag documents the value that a function returns. If you are …