@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;
};