@example

Оглавление

• Обзор
• Примеры

Обзор

Приведите пример использования документированного элемента. Текст, следующий за этим тегом, будет отображен как выделенный код.

Примеры

Обратите внимание, что у документации может быть несколько примеров.

/**
 * Solves equations of the form a * x = b
 * @example
 * // returns 2
 * globalNS.method1(5, 10);
 * @example
 * // returns 3
 * globalNS.method(5, 15);
 * @returns {Number} Returns the value of x for the equation.
 */
globalNS.method1 = function (a, b) {
    return b / a;
};

Примеры также могут иметь подписи, используя <caption></caption> после тега @example.

/**
 * Solves equations of the form a * x = b
 * @example <caption>Example usage of method1.</caption>
 * // returns 2
 * globalNS.method1(5, 10);
 * @returns {Number} Returns the value of x for the equation.
 */
globalNS.method1 = function (a, b) {
    return b / a;
};