クラスメソッドのJSDoc
静的メソッド、ゲッター、セッター、非同期メソッドを含むクラスメソッドのJSDocコメントを生成します。@memberofと@staticタグを解説します。
Classes
詳細な説明
クラスメソッドのドキュメント化
クラスメソッドは関数と同様にドキュメント化されますが、所属するクラスとアクセス修飾子（public、private、protected）に関する追加のコンテキストがあります。
シグネチャの例
class UserService {
async findByEmail(email: string): Promise<User | null>
static fromConfig(config: ServiceConfig): UserService
}
生成されるJSDoc
/**
* メールアドレスでユーザーを検索します。
*
* @param {string} email - 検索するメールアドレス（大文字小文字を区別しない）。
* @returns {Promise<User | null>} 見つかった場合のユーザー、またはそのメールの
* ユーザーが存在しない場合はnull。
* @memberof UserService
*/
静的メソッド
静的メソッドには@staticタグを使用します。
ゲッターとセッター
ゲッターは@returnsで、セッターは@paramでドキュメント化します。
アクセス修飾子タグ
| タグ | 意味 |
|---|---|
@public |
パブリックAPIで可視（デフォルト） |
@protected |
サブクラスのみアクセス可能 |
@private |
クラス内部 |
@internal |
（TSDoc）パブリックAPIの一部ではない |
ユースケース
サービス層のメソッド、リポジトリパターン、コントローラーアクション、メソッドが他のモジュールに消費されるパブリックAPIを形成するクラスベースのアーキテクチャのドキュメント化。