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 …

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

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 …

JSDoc supports a number of command-line options, many of which have both long and short forms. Alternatively, the command-line options may be specified in a configuration file given to JSDoc.

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 …

Document a custom type. Syntax @typedef [<type>] <namepath> Overview The @typedef tag is useful for documenting custom types, particularly if you wish to refer to them repeatedly. These types can …

Normally JSDoc templates would create an entire new page to display information about each level of a nested namespace hierarchy. Sometimes what you really want is to just list all the properties, …

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 tag: Block …

By using the @description tag, you can place the description anywhere in the JSDoc comment.

If you are using the JSDoc tag dictionary (enabled by default), you can also define an interface with virtual comments, rather than by writing code for the interface.