@ignore
优质
小牛编辑
126浏览
2023-12-01
描述: 忽略文档中的一个标识。
Overview(概述)
@ignore
标签表示在你的代码中的注释不应该出现在文档中,注释会被直接忽略。这个标签优先于所有其他标签。
对于大多数JSDoc模板来说,包括默认模板,@ignore
标签具有以下效果:
- 如果您和
@class
或@module
标签结合使用@ignore
标签,整个类或模块的JSDoc注释文档会被省略。 - 如果您和
@namespace
标签结合使用@ignore
标签,你还必须将@ignore
标签添加到任何子类和命名空间中。否则,会显示子类和命名空间的文档,但不完整。
Examples(例子)
在下面的例子中,@ignore
标签, Jacket
和 Jacket#color
将不会出现在文档中:
例如,在Class中使用@ignore标签:
/** * @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; } };