JSDoc @function 标签

目录

• Synonyms
• 语法
• 概述
• 示例

同义词

• JSDoc @func 标签
• JSDoc @method 标签

语法

@function [<FunctionName>]

概述

@function标记一个对象作为一个函数，即使它可能不会出现在解析器中。它设置doclet的@kind为'function'。

示例

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

如果没有@function标记，paginate对象将被记录为一个一般的对象（一个@member），因为在这行代码运行时,它不可能分辨检查paginate是什么类型的值。

/** @function myFunction */

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