购物车
登陆 / 注册
微信扫码登陆

@ignore

@ignore
@ignore标签表示在你的代码中的注释不应该出现在文档中,注释会被直接忽略。这个标签优先于所有其他标签。
编辑:青灯夜游 青灯夜游 更新时间:2019-01-07 14:51:31

@ignore

描述: 忽略文档中的一个标识。

Overview(概述)

@ignore标签表示在你的代码中的注释不应该出现在文档中,注释会被直接忽略。这个标签优先于所有其他标签。

对于大多数JSDoc模板来说,包括默认模板,@ignore标签具有以下效果:

  • 如果您和@class@module标签结合使用@ignore标签,整个类或模块的JSDoc注释文档会被省略。
  • 如果您和@namespace标签结合使用@ignore标签,你还必须将@ignore标签添加到任何子类和命名空间中。否则,会显示子类和命名空间的文档,但不完整。

Examples(例子)

在下面的例子中,@ignore标签, JacketJacket#color 将不会出现在文档中:

例如,在Class中使用@ignore标签:

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

在下面的例子中, Clothes 命名空间包含一个Jacket类。@ignore标签必须添加到ClothesClothes.Jacket中。Clothes, Clothes.JacketClothes.Jacket#color将不会出现在文档,例如:

例如,带子类的命名空间:

/**
 * @namespace
 * @ignore
 */
var Clothes = {
    /**
     * @class
     * @ignore
     */
    Jacket: function() {
        /** The jacket's color. */
        this.color = null;
    }
};
网站导航
网站首页
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
文章列表
教程文档
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ交流群
微信公众号
微信公众号