タグリファレンス - JsDoc Toolkitを使う！

トップページ > ドックコメントの書き方 >

タグリファレンス

• このページは公式サイトのタグリファレンスを日本語に翻訳、一部を再構成したものです。

タグ一覧

@augments	このクラスが継承している'基底クラス'を示します。
@author	ドキュメント化されたコードの作成者を示します。
@argument	@paramタグの非推奨の別名です。
@borrows	このクラスのメンバが他のクラスのメンバを借用していることを表します。
@class	（コンストラクタに対し）クラスの説明を記述します。
@constant	この項目の値を定数として扱うべきであることを示します。
@constructor	関数がコンストラクタであることを示します。
@constructs	@lendsタグと共に記述し、関数がコンストラクタとして用いられることを示します。
@default	プロパティのデフォルト値を記述します。
@deprecated	この項目が既にサポートされていないことを示します。
@description	説明を記述します。（コメントの1行目にタグなしで書くことと同義です）
@event	クラスによってハンドリングされるイベントを記述します。
@example	使用法の実例を示す小さなコードを提供します。
@exports	項目を実際のコードとは異なる名称でドキュメントに出力させます。 (2.2.0～)
@extends	@augmentsの別名です。
@field	項目が非関数であるとします。 関数を参照するメンバをプロパティとして出力したいときに使用します。
@fieldOf	@fieldタグと@memberOfタグを合わせて記述したのと同じ働きをします。
@fileOverview	ファイル全体についての情報を記述します。
@function	項目が関数であるとします。 変数を参照するメンバをメソッドとして出力したいときに使用します。
@ignore	JsDocToolkitがその項目を無視するようにします。
@inner	関数を内部関数とします。（@privateも参照してください）
@lends	オブジェクトリテラル内のメンバが、このタグで指定されたクラスのメンバであることを示します。
@link	他の要素へのリンクを作成します。 @seeタグと似ていますが、こちらは他のタグのテキスト内で使います。
@memberOf	この項目が、指定されたクラスのメンバであることを示します。
@methodOf	@functionタグと@memberOfタグを合わせて記述したのと同じ働きをします。
@name	JsDocToolkitに対し、このタグで指定された名称を周辺のコードとは無関係にドキュメントの構成要素として使用するように強制します。 オブジェクトリテラルのような、明示的に宣言されていない要素に名前をつけるときなどに使用します。
@namespace	オブジェクトリテラルが"名前空間"であることを示します。
@param	関数のパラメータを記述します。
@private	この項目がprivateなメンバであることを示します。（これらを出力するには、コマンドラインオプションで-pを指定します）
@property	コンストラクタのコメント内で、クラスのプロパティの情報を記述します。
@public	この項目がpublicなメンバであることを示します。
@requires	この項目の動作に必要なリソースを記述します。
@returns	関数の戻り値を記述します。
@see	他のリソースへのリンクを作成します。
@since	この項目が有効になった特定のバージョン番号を示します。
@static	クラスがインスタンス化を必要としない静的クラスであることを示します。
@throws	関数が投げる例外を記述します。
@type	項目が求めるデータ型、または関数の戻り値のデータ型を記述します。
@version	このコードのリリースバージョンを示します。

タグの別名

各タグについて、以下に示す別名を使うこともできます。

@augments	@base, @extends
@borrows	@inherits
@class	@classdescription
@constructor	@construct
@description	@desc
@fileOverview	@overview, @projectdescription
@lends	@scope
@memberOf	@member, @memberof
@param	@argument
@returns	@return
@throws	@exception

---