@constant

Содержание

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

Синонимы

@const

Синтаксис

@constant [<type> <name>]

Обзор

Тег @constant используется для маркировки документации, относящейся к символу, являющемуся константой.

Примеры

В этом примере мы документируем строковую константу. Обратите внимание, что, хотя код использует ключевое слово const, это не требуется JSDoc. Если ваша среда выполнения JavaScript пока не поддерживает объявления констант, документацию @const можно с тем же успехом использовать для var объявлений.

Строковая константа, представляющая цвет красный

/** @constant
    @type {string}
    @default
*/
const RED = 'FF0000';

/** @constant {number} */
var ONE = 1;

Обратите внимание, что пример предоставляет тип в теге @type. Это необязательно. Также здесь используется необязательный тег @default, который автоматически добавит присвоенное значение (например, 'FF0000') к документации.