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 …

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. …

@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 …

@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 …

@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 …

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 …

@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, …

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 …

@use JSDoc Syntax. @module [[{<type>}] <moduleName>] In JSDoc 3.3.0 and later, <moduleName> may include the module: prefix. In previous versions, you must omit this …