概要

@ignore タグは、コード内のシンボルをドキュメントに決して表示すべきでないことを示します。このタグは、他のすべてのタグよりも優先されます。

デフォルトのテンプレートを含むほとんどの JSDoc テンプレートでは、@ignore タグには次の効果があります。

• @class または @module タグで @ignore タグを使用すると、クラスまたはモジュール全体がドキュメントから省略されます。
• @namespace タグで @ignore タグを使用する場合は、@ignore タグを子クラスと名前空間にも追加する必要があります。 そうしないと、ドキュメントには子クラスと名前空間が表示されますが、名前は不完全です。

例

次の例では、Jacket と Jacket#color はドキュメントに表示されません。

/**
 * @class
 * @ignore
 */
function Jacket() {
    /** The jacket's color. */
    this.color = null;
}

次の例では、Clothes 名前空間に Jacket クラスが含まれています。 @ignore タグは、Clothes と Clothes.Jacket の両方に追加する必要があります。 Clothes、Clothes.Jacket、Clothes.Jacket#color はドキュメントに表示されません。

/**
 * @namespace
 * @ignore
 */
var Clothes = {
    /**
     * @class
     * @ignore
     */
    Jacket: function() {
        /** The jacket's color. */
        this.color = null;
    }
};