@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() {
}