@name

Оглавление

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

Синтаксис

@name <namePath>

Обзор

Тег @name заставляет JSDoc связать оставшуюся часть комментария JSDoc с заданным именем, игнорируя весь окружающий код. Этот тег лучше всего использовать в «виртуальных комментариях» для символов, которые не сразу видны в коде, таких как методы, которые генерируются во время выполнения.

Когда вы используете тег @name, вы должны предоставить дополнительные теги, которые расскажут JSDoc, какой тип символа вы документируете; является ли этот символ членом другого символа; и так далее. Если вы не предоставите эту информацию, символ не будет правильно задокументирован.

Предупреждение: Используя тег @name, вы говорите JSDoc проигнорировать окружающий код и рассматривать ваш комментарий к документации изолированно. Во многих случаях лучше использовать тег @alias, который изменяет имя символа в документации, но сохраняет другую информацию о символе.

Примеры

Следующий пример демонстрирует, как использовать тег @name для документирования функции, которую JSDoc обычно не распознаёт.

/**
 * @name highlightSearchTerm
 * @function
 * @global
 * @param {string} term - The search term to highlight.
 */
eval("window.highlightSearchTerm = function(term) {};")

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

• Использование namepaths с JSDoc 3
• @alias