描述: 描述一个函数或方法。
别名:
@function [<FunctionName>]
标记一个对象作为一个函数,即使它可能不会出现在解析器中。它设置doclet的@kind为'function'。
例如,使用@function标记为一个函数:
/** @function */
var paginate = paginateFactory(pages);
如果没有@function标记,paginate
对象将被记录为一个一般的对象(一个@member),因为在这行代码运行时,它不可能分辨检查paginate
是什么类型的值。
例如,使用带函数名的@function:
/** @function myFunction */
// the above is the same as:
/** @function
* @name myFunction */