@function

Оглавление

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

Синонимы

• @func
• @method

Синтаксис

@function [<FunctionName>]

Обзор

Это отмечает объект как функцию, даже если он может не выглядеть таковым для парсера. Устанавливает для тега doclet @kind значение 'function'.

Примеры

/** @function */
var paginate = paginateFactory(pages);

Без тега @function объект paginate был бы задокументирован как обычный объект (а @member), так как невозможно определить тип значения paginate по коду.

/** @function myFunction */

// the above is the same as:
/** @function
 * @name myFunction */