@classdesc

Содержание

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

Синтаксис

@classdesc <some description>

Обзор

Тег @classdesc используется для предоставления описания класса, отделенного от описания конструкторской функции. Используйте тег @classdesc в сочетании с @class (или @constructor) тегом.

Функциональность тега @classdesc в JSDoc 3 дублирует функциональность тега @class в предыдущих версиях. Начиная с версии 3, синтаксис и функциональность тега @class теперь точно соответствует тегу @constructor, а тег @classdesc более явно указывает на свою цель: документировать описание класса.

Примеры

Как показано ниже, класс имеет места для двух описаний, одно относится к самой функции, а другое — к классу в целом.

/**
 * This is a description of the MyClass constructor function.
 * @class
 * @classdesc This is a description of the MyClass class.
 */
function MyClass() {
}

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

• @class
• @description