構文

@enum [<type>]

概要

@enum タグは、値がすべて同じ型の静的プロパティのコレクションをドキュメント化します。

enum はプロパティのコレクションに似ていますが、enum は独自のドキュメントコメントでドキュメント化されるのに対し、プロパティはコンテナのドキュメントコメントの中でドキュメント化されます。多くの場合、enum は通常定数の集合を表すため、このタグは @readonly で使用されます。

例

これは、3 つの可能な状態を持つ値を表すオブジェクトをドキュメント化する方法を示しています。必要に応じて、enum メンバーに任意の説明を追加できます。また、「MAYBE」で示されているように、型をオーバーライドすることもできます。デフォルトでは、enum メンバーは enum 自体と同じ型でドキュメント化されます。

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

関連リンク

• @property