当前位置: 首页 > 文档资料 > JSDoc 中文文档 >

@enum

优质
小牛编辑
129浏览
2023-12-01

描述:描述一个相关属性的集合。

Syntax(语法)

@enum [<type>]

Overview(概述)

@enum标签描述一个静态属性值的全部相同的集合。枚举类似一个属性的集合,除了枚举自己的描述注释之外,属性都记录在容器内部的注释中。通常这种标签是与@ReadOnly结合使用,作为一个枚举通常表示常量的集合。

Examples(例子)

这个例子表明如何记录一个对象,这个对象有三个可能的状态的值。请注意,枚举成员可以添加一个可选的描述,如果你的希望的话。你也可以覆盖类型,如下所示的"MAYBE" -- 默认情况下,枚举成员将被记录为与枚举本身相同的类型。

例如,一个数字枚举,表示的3种状态:

/**
 * Enum for tri-state values.
 * @readonly
 * @enum {number}
 */
var triState = {
    /** The true value */
    TRUE: 1,
    FALSE: -1,
    /** @type {boolean} */
    MAYBE: true
};