概述

@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;
    }
};