@enum¶

.. @enum::¶

语法

@enum [<type>]

概述

@enum标记记录了一组静态属性, 这些属性的值都是相同的类型.

枚举类似于属性集合, 除了枚举在其自己的doc注释中记录, 而属性记录在其容器的doc注释中. 这个标签通常与@readonly一起使用, 因为枚举通常代表一组常量.

示例

这显示了如何记录表示具有三种可能状态的值的对象. 请注意, 如果您愿意, 枚举成员可以添加可选说明. 您也可以覆盖类型, 如“MAYBE”所示 - 默认情况下, 枚举成员将记录与枚举本身相同的类型.

A numeric enum, representing three states¶

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