加载中...

@function


描述: 描述一个函数或方法。

别名:

  • @func
  • @method

Syntax(语法)

@function [<FunctionName>]

Overview(概述)

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

Examples(例子)

例如,使用@function标记为一个函数:

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

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

例如,使用带函数名的@function:

  1. /** @function myFunction */
  2. // the above is the same as:
  3. /** @function
  4. * @name myFunction */

还没有评论.