@use JSDoc

概述

提供有关如何使用已记录项的示例。此标记后面的文本将显示为高亮代码。

示例

请注意，一个文档可能有多个示例。

记录示例
/**
 * 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;
};

在 @example 标记之后，还可以使用 <caption></caption> 为示例添加标题。

记录带有标题的示例
/**
 * Solves equations of the form a * x = b
 * @example &lt;caption>Example usage of method1.&lt;/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;
};