同义词

• func
• 方法

语法

@function [<FunctionName>]

概述

即使解析器可能不会将对象视为函数，此标记也会将对象标记为函数。它将文档的 @kind 设置为“函数”。

示例

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

如果没有 @function 标记，paginate 对象将被记录为一个通用对象（一个 @member），因为无法通过检查代码行来判断运行时 paginate 将保存哪种类型的值。

/** @function myFunction */

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