@default

Оглавление

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

Синонимы

@defaultvalue

Синтаксис

@default [<some value>]

Обзор

Тег @default позволяет документировать присвоенное значение символа. Вы можете указать это значение самостоятельно или позволить JSDoc автоматически документировать значение из исходного кода — это возможно только тогда, когда документируемый символ получает единственное простое значение, которое является: строкой, числом, булевым значением или null.

Примеры

В этом примере документируется константа. Значение константы 0xff0000. Добавив тег @default, это значение автоматически добавляется в документацию.

/**
 *  @constant
 *  @default
 */
const RED = 0xff0000;