@namespace - JsDoc Toolkitを使う！

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

@namespace

@namespaceタグは、あるオブジェクトが単一のグローバルな名前のもとにプロパティやメソッドの集合を保持する"名前空間"として使用されていることを示します。

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

構文

@namespace description

• description -- 省略可：この名前空間についての説明

例

この例では load 関数は Extensions.PluginManager のメンバとして現れます。

/**
   @namespace Holds functionality related to running plugins.
 */

Extensions.PluginManager = {
};

Extensions.PluginManager.load = function(plugin) {
};

ドキュメント化される際、名前空間はJavaScriptの組み込みオブジェクトである Math とよく似た（コンストラクタを持たない）静的クラスのように扱われるべきです。名前空間は他のクラスと並んでリストされるべきですが、それに関する記述の中にコンストラクタが現れることはありません。

---