@ignore - JsDoc Toolkitを使う！

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

@ignore

@ignoreタグは、このタグが無ければ出力されるようなコード内の項目について、それをドキュメントから除外するようにJsDoc Toolkitに強制します。このタグは他の全ての機構に優先され、タグ付けされた要素がドキュメントに出力されないことが保証されます。

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

構文

@ignore

例

/**
 * @constructor
 * @ignore
 */

function Foo() {
    this.bar = function() {
    }
}

注意：上の例では、 Foo と bar は共に、ドキュメントの出力から除外されます。親オブジェクトが無視される場合、そこに含まれる全メンバもまた無視されます。

---