@description

Содержание

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

Синонимы

@desc

Синтаксис

@description <some description>

Обзор

Тег @description позволяет указать общее описание символа, который вы документируете. Описание может включать HTML-разметку. Оно также может включать форматирование Markdown, если плагин Markdown включен.

Примеры

Если вы описываете символ в самом начале комментария JSDoc, до использования любых блочных тегов, вы можете опустить тег @description.

/**
 * Add two numbers.
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function add(a, b) {
    return a + b;
}

Используя тег @description, вы можете разместить описание в любом месте комментария JSDoc.

/**
 * @param {number} a
 * @param {number} b
 * @returns {number}
 * @description Add two numbers.
 */
function add(a, b) {
    return a + b;
}

Если есть описание в начале комментария JSDoc и описание, заданное с помощью тега @description, то описание, указанное с помощью тега @description, перекроет описание в начале комментария.

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

• @classdesc
• @summary