@static - JsDoc Toolkitを使う！

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

@static

@staticタグは、その要素が、要素の属するオブジェクトのインスタンス化をしなくてもアクセス可能な静的メンバであることを示します。

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

構文

@static

例

var Hello = {};

/**
 * @static
 */

Hello.World = function() {
    alert("Hello world");
}

このケースでは、 World 関数は Hello オブジェクトのスタティックメソッドとしてドキュメント化されます。ほとんどの場合JsDoc Toolkitのパーサはコードそのものからその事実を判断できますが、まれにそれが出来ないときには、このタグが必要となるでしょう。

関連項目

• @namespaceタグは、ある変数が静的なプロパティとともに"名前空間"のように用いられることを示すのに使用されます。

---