@memberOf - JsDoc Toolkitを使う！

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

@memberOf

@memberOfタグは、要素に対し任意の"親"階層を規定することを可能にします。

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

別名

@member, @memberof

構文

@memberOf parentNamepath

• parentNamepath -- 必須：要素が属する階層のネームパス

例

var Tools = {};

/** @namespace */

Tools.Dom = {};

/** @memberOf Tools.Dom */

var hiliteSearchTerm = function(term) {
}

Tools.Dom.highlightSearchTerm = hiliteSearchTerm;

@memberOfタグがなければ、 hiliteSearchTerm 関数はグローバル関数として出力されます。事実それはグローバル関数でもあり、また Tools.Dom 名前空間のメンバでもあるので、出力結果はそれをどのようにドキュメント化したいのかによって決まります。

注意

デフォルト、つまり上の例のように書くと、メンバは静的メンバとして出力されます。もしそれをインスタンスやprototypeに属するように出力したい場合は、名前空間の指定を次のように修正してください。:

@memberOf Tools.Dom#

または

@memberOf Tools.Dom.prototype

付記

@memberOfと結びつけられているかのように作用する２つのタグがあります。

• @methodOf -- @functionと@memberOfを合わせた働きをする短い別名です。
• @fieldOf -- @fieldと@memberOfを合わせた働きをする短い別名です。

関連項目

• @nameタグ

---