同義語

• func
• method

構文

@function [<関数の名前>]

概要

これはオブジェクトを関数としてマークするものであり、パーサーにはそう見えない場合でもです。これにより、そのドキュレットの @kind が「関数」に設定されます。

例

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

@function タグがないと、paginate オブジェクトは一般オブジェクト（@member）としてドキュメント化されます。コードの行の検査からは、paginate が実行されたときにどのような値が保持されるかを特定することはできないからです。

/** @function myFunction */

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