@function (synonyms: @func, @method)¶
-
.. @function::
¶ - 同义词
- 语法
@function [<FunctionName>]
- 概述
This marks an object as being a function, even though it may not appear to be one to the parser. It sets the doclet’s
@kind
to ‘function’.- 示例
- Using @function to mark a function.¶
/** @function */ var paginate = paginateFactory(pages);
Without the @function tag, the
paginate
object would be documented as a generic object (a@member
), because it isn’t possible to tell from examining the line of code what type of valuepaginate
will hold when it is run.Using @function with a name.¶/** @function myFunction */ // the above is the same as: /** @function * @name myFunction */