JsDoc Toolkitを使う!
メタタグ
最終更新:
aias-jsdoctoolkit
トップページ > ドックコメントの書き方 >
メタタグ
/**# から始まるドックコメントはメタタグとして扱われ、JsDoc Toolkitに対し何らかの処理を指示する特別な構文として機能します。
- このページは公式サイトのhttp://code.google.com/p/jsdoc-toolkit/wiki/MetaTagsを日本語に翻訳、一部を再構成したものです。
タグの共有
「タグの共有」命令を使うと、指定された範囲のコード内に記述された全ての要素に対しタグのセットを適用できるようになります。
構文
/**#@+
anyTags
*/
....
/**#@-*/
- anyTags -- 必須:共有したいタグのグループ
- 注意:この指示の効果は、ファイルの終端に達するか、 /**#@-*/ ドックコメントが現れるまで続きます。
例
「タグの共有」命令の中のタグは、範囲内の関数全てに適用されます。
function baz() {}
function zop() {}
function pez() {}
/**#@-*/
この例では、3つの関数全てが
Foo
のプライベートメンバとしてドキュメント化されます。この構文は3つの独立したドックコメントを記述するのに比べてよりコンパクトで使いやすいものです。
コードの不可視化
コードの不可視化を行うメタタグは、指定範囲内にあるソースコードを完全に無視するようにJsDoc Toolkitのパーサに指示します。これは -n コマンドラインオプションを一時的に有効にしているのと同じ効果です。
構文
/**#nocode+*/
....
/**#nocode-*/
- 注意:この指示の効果は、ファイルの終端に達するか、 /**#nocode-*/ ドックコメントが現れるまで続きます。
/**#@+
@private
@memberOf Foo
*/