JSDoc Cheatsheet

Documentation Tags

Tags for linking, examples, and additional documentation

@example
Provides usage examples

Syntax:

@example // Example code here

Example:

/**
 * @example
 * // Basic usage
 * const result = myFunction('test');
 * console.log(result);
 */
@see
References related documentation or code

Syntax:

@see {reference}

Example:

/**
 * @see {@link MyClass#method}
 * @see https://example.com/docs
 */
@link
Creates inline links to other documentation

Syntax:

{@link reference}

Example:

/**
 * Uses {@link MyClass} for processing
 */
@tutorial
Links to a tutorial document

Syntax:

@tutorial TutorialName

Example:

/**
 * @tutorial getting-started
 */
@todo
Documents future improvements or fixes needed

Syntax:

@todo Description of what needs to be done

Example:

/**
 * @todo Add input validation
 * @todo Optimize performance
 */