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