@example

Syntax

@example
code here

@example <caption>Caption text</caption>
code here

Overview

@example embeds a code example directly in the documentation for a symbol. Multiple @example tags are allowed in one comment block. An optional <caption> element provides a title for the example.

Examples

Simple example

/**
 * Clamps a number between a minimum and maximum value.
 * @param {number} value
 * @param {number} min
 * @param {number} max
 * @returns {number}
 * @example
 * clamp(15, 0, 10); // → 10
 * clamp(-5, 0, 10); // → 0
 * clamp(7, 0, 10);  // → 7
 */
function clamp(value, min, max) {
  return Math.min(Math.max(value, min), max);
}

Example with a caption

/**
 * @example <caption>Creating a user</caption>
 * const user = new User({ name: 'Alice', role: 'admin' });
 *
 * @example <caption>Creating a guest user</caption>
 * const guest = new User({ name: 'Guest' });
 */
class User {}

See also

• @description
• @tutorial

Official reference: jsdoc.app/tags-example