@function - JsDoc Toolkitを使う！

トップページ > ドックコメントの書き方 > タグリファレンス >

@function

@functionタグは、JsDocToolkitに対し、この項目を関数として扱うように強制します。

• http://code.google.com/p/jsdoc-toolkit/wiki/TagFunction

構文

@function

例

/**
 * @function
 */

var paginate = paginateFactory(pages);

@functionタグが無い場合、 paginate は一般的なオブジェクト変数として出力されます。プログラム実行時に paginate がどのようなデータ型を持つのか、コードの解析からは判断できないからです。

関連項目

• @fieldタグ

---