JSDoc Cheatsheet

Functions & Classes

Document functions, classes, constructors, and methods

@function
Explicitly marks something as a function

Syntax:

@function

Example:

/**
 * @function calculateTotal
 * @description Calculates order total
 */
@class
Documents a class

Syntax:

@class

Example:

/**
 * @class
 * @description Represents a user account
 */
@constructor
Documents a constructor function

Syntax:

@constructor

Example:

/**
 * @constructor
 * @param {string} name - User name
 */
@method
Documents a method

Syntax:

@method

Example:

/**
 * @method getName
 * @returns {string} The user name
 */
@static
Indicates a static method or property

Syntax:

@static

Example:

/**
 * @static
 * @method createUser
 */
@override
Indicates method overrides parent method

Syntax:

@override

Example:

/**
 * @override
 * @method toString
 */