デフォルトパラメータを持つ関数のJSDoc

デフォルトパラメータのドキュメント化

関数パラメータにデフォルト値がある場合、JSDocコメントはパラメータがオプションであることとデフォルト値が何であるかの両方を示す必要があります。

シグネチャの例

function formatDate(
  date: Date,
  locale: string = "en-US",
  options: Intl.DateTimeFormatOptions = { dateStyle: "medium" }
): string

生成されるJSDoc

/**
 * Dateオブジェクトをローカライズされた文字列表現にフォーマットします。
 *
 * @param {Date} date - フォーマットする日付。
 * @param {string} [locale="en-US"] - BCP 47ロケールタグ。デフォルトは"en-US"。
 * @param {Intl.DateTimeFormatOptions} [options] - フォーマットオプション。
 *   デフォルトは{ dateStyle: "medium" }。
 * @returns {string} フォーマットされた日付文字列。
 */

デフォルト値のJSDoc構文

JSDocでは、デフォルト値を持つオプションパラメータは名前を角括弧で囲みます：

• @param {string} [locale="en-US"] — デフォルト値付きオプション
• @param {string} [locale] — デフォルトを指定しないオプション
• @param {string} locale — 必須

型が推論される場合

TypeScriptとTSDocスタイルを使用する場合、型はシグネチャに含まれているため波括弧は不要です。ただし説明テキストでデフォルト値に言及する必要があります。