@ignore¶
-
.. @ignore::
¶ - 语法
@ignore
- 概述
The
@ignore
tag indicates that a symbol in your code should never appear in the documentation. This tag takes precedence over all others.For most JSDoc templates, including the default template, the
@ignore
tag has the following effects:If you use the
@ignore
tag with the@class
or@module
tag, the entire class or module will be omitted from the documentation.If you use the
@ignore
tag with the@namespace
tag, you must also add the@ignore
tag to any child classes and namespaces. Otherwise, your documentation will show the child classes and namespaces, but with incomplete names.
- 示例
在下面的例子中, ``Jacket``和``Jacket #color``将不会出现在文档中.
/** * @class * @ignore */ function Jacket() { /** The jacket's color. */ this.color = null; }
In the following example, the
Clothes
namespace contains aJacket
class. The@ignore
tag must be added to bothClothes
andClothes.Jacket
.Clothes
,Clothes.Jacket
, andClothes.Jacket#color
will not appear in the documentation.Namespace with child class¶/** * @namespace * @ignore */ var Clothes = { /** * @class * @ignore */ Jacket: function() { /** The jacket's color. */ this.color = null; } };