@classdesc

.. @classdesc::

语法

@classdesc <some description>

概述

The @classdesc tag is used to provide a description for a class, separate from the constructor function’s description. Use the @classdesc tag in combination with the [@class (or @constructor) tag]class.

JSDoc 3中@classdesc标记的功能与先前版本中@class的功能重复. 从版本3开始, @ class标签的语法和功能现在与@constructor标签完全匹配, @ classdesc标签更明确地传达其目的: 记录类的描述.

示例

如下所示, 类具有两个描述的位置, 一个适用于函数本身, 而另一个适用于该类.

具有构造函数描述和类描述的doclet

/**
 * This is a description of the MyClass constructor function.
 * @class
 * @classdesc This is a description of the MyClass class.
 */
function MyClass() {
}