JSDoc Cheatsheet

Modules & Namespaces

Organize code with modules, namespaces, and membership

@module
Documents a module

Syntax:

@module ModuleName

Example:

/**
 * @module UserUtils
 * @description Utilities for user management
 */
@namespace
Documents a namespace

Syntax:

@namespace NamespaceName

Example:

/**
 * @namespace MyApp.Utils
 */
@memberof
Indicates membership in a parent

Syntax:

@memberof ParentName

Example:

/**
 * @memberof MyApp.Utils
 * @function formatName
 */
@exports
Documents what a module exports

Syntax:

@exports ModuleName

Example:

/**
 * @exports UserService
 */
@requires
Documents module dependencies

Syntax:

@requires ModuleName

Example:

/**
 * @requires lodash
 */