@use JSDoc

语法

@classdesc <一些描述>

概述

@classdesc 标记用于提供一个类的描述,与构造函数的描述分开。将 @classdesc 标记与 @class(或 @constructor)标记 结合使用。

JSDoc 3 中 @classdesc 标记的功能与以前版本中的 @class 相同。从版本 3 开始,@class 标记的语法和功能现在与 @constructor 标记完全匹配,而 @classdesc 标记更明确地传达了其目的:记录类的描述。

示例

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

具有构造函数描述和类描述的文档
/**
 * This is a description of the MyClass constructor function.
 * @class
 * @classdesc This is a description of the MyClass class.
 */
function MyClass() {
}