@requires

Содержание

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

Синтаксис

@requires <someModuleName>

Обзор

Тег @requires позволяет документировать, что для использования этого кода необходим модуль. В комментарии JSDoc может быть несколько тегов @require. Имя модуля может быть указано как "moduleName" или "module:moduleName"; оба формата будут интерпретированы как модули.

JSDoc не пытается обработать включаемый модуль. Если вы хотите, чтобы модуль был включён в документацию, необходимо включить модуль в список JavaScript-файлов для обработки.

Примеры

/**
 * This class requires the modules {@link module:xyzcorp/helper} and
 * {@link module:xyzcorp/helper.ShinyWidget#polish}.
 * @class
 * @requires module:xyzcorp/helper
 * @requires xyzcorp/helper.ShinyWidget#polish
 */
function Widgetizer() {}