Getting started with JSDoc A quick start to documenting JavaScript with JSDoc. Using namepaths with JSDoc A guide to using namepaths with JSDoc. Command-line arguments to JSDoc About command-line arguments to JSDoc. Configuring JSDoc with a configuration file How to configure JSDoc using a configuration file. Configuring JSDoc's default template

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 JSDoc tool will scan your source code and generate …

@use JSDoc Syntax. @type {typeName} Overview. The @type tag allows you to provide a type expression identifying the type of value that a symbol may contain, or the type of value returned by a function. You can also include type expressions with …

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 automatically identifies classes and their constructors simply by parsing your code.

@use JSDoc Synonyms. arg; argument; Overview. The @param tag provides the name, type, and description of a function parameter. The @param tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.

@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 multiple examples. Documenting examples

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-step process for implementing a feature.

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 configuration file that enables JSDoc's Markdown plugin .

@use JSDoc Synonyms. return; Syntax. @returns [{type}] [description] Overview. The @returns tag documents the value that a function returns. If you are documenting a generator function, use the @yields tag instead of this tag. Examples Return value with a type

@use JSDoc Overview. The @inheritdoc tag indicates that a symbol should inherit its documentation from its parent class. Any other tags that you include in the JSDoc comment will be ignored. This tag is provided for compatibility with Closure Compiler. By default, if you do not add a JSDoc comment to a symbol, the symbol will inherit ...