@use JSDoc

同義詞

語法

@constant [<type> <name>]

概觀

@constant 標籤用於將文件標記為屬於常數符號。

範例

在這個範例中，我們文件化一個字串常數。請注意，儘管程式碼使用 const 關鍵字，但 JSDoc 並不要求這樣做。如果您的 JavaScript 主機環境尚不支援常數宣告，則 @const 文件也可以有效地用於 var 宣告。

表示紅色的一個字串常數
/** @constant
    @type {string}
    @default
*/
const RED = 'FF0000';

/** @constant {number} */
var ONE = 1;

請注意，範例在 @type 標籤中提供類型。這是可選的。此外，這裡也使用了可選的 @default 標籤，這會自動將指定的任何值（例如 'FF0000'）新增到文件中。