クラスコンストラクターのJSDoc

クラスコンストラクターのドキュメント化

クラスコンストラクターはオブジェクトインスタンスを初期化します。ドキュメントでは、クラスが何を表すか、コンストラクターパラメータは何か、構築の副作用を説明する必要があります。

シグネチャの例

class DatabaseConnection {
  constructor(
    host: string,
    port: number = 5432,
    options?: { ssl: boolean; timeout: number }
  )
}

生成されるJSDoc

/**
 * PostgreSQLデータベースへの接続を管理します。
 *
 * @class DatabaseConnection
 */

/**
 * 新しいDatabaseConnectionインスタンスを作成します。
 *
 * @param {string} host - データベースサーバーのホスト名またはIPアドレス。
 * @param {number} [port=5432] - ポート番号。デフォルトは5432。
 * @param {object} [options] - 追加の接続オプション。
 * @param {boolean} options.ssl - SSL暗号化を使用するかどうか。
 * @param {number} options.timeout - 接続タイムアウト（ミリ秒）。
 */

2レベルのドキュメント

クラスには通常2つのコメントブロックが必要です：

1. クラスレベル: @classタグを使用してクラスの目的を説明
2. コンストラクターレベル: コンストラクターのパラメータをドキュメント化