コールバックパラメータのJSDoc

コールバックパラメータのドキュメント化

関数がコールバックをパラメータとして受け取る場合、ドキュメントではコールバックが何をするか、いつ呼び出されるか、どの引数を受け取るかを説明する必要があります。

シグネチャの例

function debounce<T extends (...args: unknown[]) => unknown>(
  fn: T,
  delay: number,
  options?: { leading?: boolean; trailing?: boolean }
): T

生成されるJSDoc

/**
 * 最後の呼び出しから指定された遅延が経過するまで
 * 呼び出しを遅延させるデバウンスされた関数を作成します。
 *
 * @template T - デバウンスする関数の型。
 * @param {T} fn - デバウンスする関数。遅延期間後に
 *   最新の引数で呼び出されます。
 * @param {number} delay - デバウンスの遅延（ミリ秒）。
 * @param {object} [options] - デバウンスの動作オプション。
 * @returns {T} デバウンスされた同じシグネチャの新しい関数。
 */

タイミングのドキュメント

コールバックがいつ呼び出されるかを必ずドキュメント化してください：実行中に同期的に、完了後に非同期的に、各反復で、または特定の条件でのみ。