@enum

Содержание

• Синтаксис
• Обзор
• Примеры
• Связанные ссылки

Синтаксис

@enum [<type>]

Обзор

Тег @enum документирует набор статических свойств, значения которых имеют один и тот же тип.

Перечисление (enum) похоже на коллекцию свойств, за исключением того, что перечисление документируется в своем собственном комментарии документации, в то время как свойства документируются в комментарии документации своего контейнера. Часто этот тег используется с @readonly, так как перечисление обычно представляет собой коллекцию констант.

Примеры

Это демонстрирует, как документировать объект, представляющий значение с тремя возможными состояниями. Обратите внимание, что членам перечисления можно добавить необязательные описания, если вы этого хотите. Также вы можете переопределить тип, как показано со значением "MAYBE" — по умолчанию члены перечисления будут документированы с тем же типом, что и само перечисление.

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

Связанные ссылки

@property