@use JSDoc

構文

@classdesc <なんらかの説明>

概要

@classdescタグは、コンストラクタ関数の説明とは別に、クラスの説明を提供するために使用されます。@classdescタグは、@class(または@constructor)タグと組み合わせて使用します。

JSDoc 3の@classdescタグの機能は、以前のバージョンでの@classと同じです。バージョン3以降、@classタグの構文と機能は、@constructorタグと完全に同じになり、@classdescタグはクラスの説明を文書化する目的を明確に示しています。

以下に示すように、クラスには2つの説明を記述できます。1つは関数自体に適用され、もう1つはクラス全体に適用されます。

コンストラクタ関数記述とクラス記述の両方を含むドキュレット
/**
 * This is a description of the MyClass constructor function.
 * @class
 * @classdesc This is a description of the MyClass class.
 */
function MyClass() {
}