@kind

Содержание

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

Синтаксис

@kind <kindName>

где <kindName> — это одно из:

• класс
• константа
• событие
• внешний
• файл
• функция
• член
• микшин
• модуль
• пространство имён
• тип

Обзор

Тег @kind используется для документации того, какого типа символ документируется (например, класс или модуль). Тип символа отличается от типа значения символа (например, строка или булево значение).

Обычно тег @kind не требуется, так как тип символа определяется другими тегами в doclet. Например, использование тега @class автоматически подразумевает "@kind класс", а использование тега @namespace подразумевает "@kind пространство имён".

Примеры

// The following examples produce the same result:

/**
 * A constant.
 * @kind constant
 */
const asdf = 1;

/**
 * A constant.
 * @constant
 */
const asdf = 1;

В случае тегов с конфликтующими типами (например, использование как @module, которое задаёт тип "модуль", так и "@kind константа", которое задаёт тип "константа"), последний тег определяет тип.

/**
 * This will show up as a constant
 * @module myModule
 * @kind constant
 */

/**
 * This will show up as a module.
 * @kind constant
 * @module myModule
 */

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

@тип