@inner - JsDoc Toolkitを使う！

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

@inner

@innerタグは関数が内部関数であることを示すのに使われます。内部関数は外側の関数のスコープ内で宣言され、外部から直接アクセスすることはできません。

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

構文

@inner

例

多くの場合このタグは必要ありません。通常JsDoc Toolkitはコードそのものから内部関数を認識できるからです。

/**
   @constructor
 */

Person = function() {

    /** @inner */

    function daydream() {
    }
}

Person 関数のスコープの制約により、 daydream 関数には Person の外側からアクセスできません。このことにより、JsDoc Toolkitは@privateタグが付いているかのようにこの関数を扱います。

関連項目

• @privateタグ

---