概觀

@ignore 標籤表示程式碼中的符號不應出現在文件當中。此標籤優先於所有其他標籤。

對於大多數 JSDoc 範本，包括預設範本，@ignore 標籤具有下列效果

• 如果您將 @ignore 標籤與 @class 或 @module 標籤一起使用，整個類別或模組將從文件中省略。
• 如果您將 @ignore 標籤與 @namespace 標籤一起使用，您還必須將 @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;
    }
};