@use JSDoc

語法

@enum [<type>]

概述

@enum 標籤用於記錄一系列靜態屬性,其值類型皆相同。

列舉與屬性集合類似,但列舉會記錄在自己的文件註解中,而屬性則記錄在其容器的文件註解中。此標籤通常會與 @readonly 搭配使用,因為列舉通常代表常數集合。

範例

以下範例說明如何記錄一個代表三種可能狀態的物件。請注意,列舉成員可以選擇性地加上說明。您也可以覆寫類型,如「MAYBE」所示,預設上列舉成員會記錄與列舉本身相同的類型。

表示三種狀態的數字列舉
/**
 * Enum for tri-state values.
 * @readonly
 * @enum {number}
 */
var triState = {
    /** The true value */
    TRUE: 1,
    FALSE: -1,
    /** @type {boolean} */
    MAYBE: true
};