@classdesc
优质
小牛编辑
133浏览
2023-12-01
描述: 使用后面的文字来描述整个类。
Syntax(语法)
@classdesc <some description>
Overview(概述)
@classdesc
标签用于为类提供一个描述,这样和构造函数的描述区分开来。@classdesc
标签应该与 @class (或 @constructor)标签
结合使用。
在JSDoc 3 中 @classdesc
标签的功能和以前版本中的@class
标签的功能是重复的。截至第3版,@class
标签的语法和功能和现在的@constructor
标签是完全匹配的,并且@classdesc标签更明确地传达其目的:记录一类的描述。
Examples(例子)
如下所示,一个类有两个添加描述的地方,一个适用于函数本身,而另一个一般适用于类。
例如,一个同时具有构造函数描述和类说明的doclet:
/** * This is a description of the MyClass constructor function. * @class * @classdesc This is a description of the MyClass class. */ function MyClass() { }