JSDoc Cheatsheet

Advanced Tags

Advanced JSDoc features for complex documentation needs

@callback
Documents a callback function type

Syntax:

@callback CallbackName

Example:

/**
 * @callback RequestCallback
 * @param {Error} error
 * @param {Object} response
 */
@event
Documents an event

Syntax:

@event EventName

Example:

/**
 * @event MyClass#dataLoaded
 * @type {Object}
 */
@fires
Indicates function fires an event

Syntax:

@fires EventName

Example:

/**
 * @fires MyClass#dataLoaded
 */
@listens
Indicates function listens to an event

Syntax:

@listens EventName

Example:

/**
 * @listens MyClass#dataLoaded
 */
@mixes
Documents that class mixes in another

Syntax:

@mixes MixinName

Example:

/**
 * @mixes EventEmitter
 */
@abstract
Indicates abstract method or class

Syntax:

@abstract

Example:

/**
 * @abstract
 * @method process
 */