アロー関数とconst宣言のJSDoc
const、let、varで宣言されたアロー関数のJSDocを生成します。関数宣言とアロー式のドキュメントの違いを解説します。
Function Styles
詳細な説明
アロー関数のドキュメント化
アロー関数はモダンJavaScriptで一般的で、特にコールバック、Reactコンポーネント、モジュールエクスポートで使用されます。JSDocコメントはアローの上ではなく、変数宣言の上に配置します。
シグネチャの例
const formatPrice = (amount: number, currency: string = "USD"): string => {
// ...
}
配置ルール
アロー関数の場合、コメントをconst/let/varキーワードの直上に配置します：
/** これが正しい */
const fn = () => {};
const fn = /** これは間違い */ () => {};
名前付き vs 匿名
変数に代入されたアロー関数は、変数名がドキュメント名になります。高階関数に直接渡される匿名アロー関数の場合は、呼び出し関数のパラメータでドキュメント化します。
暗黙的な戻り値
暗黙的な戻り値を持つアロー関数の場合、コードにreturnキーワードが見えないため、@returnsの説明は特に明確にする必要があります。
ユースケース
アロー関数としてエクスポートされるユーティリティモジュール、Reactイベントハンドラー、配列メソッドコールバック、Expressルートハンドラー、pipeやcomposeなどの関数型プログラミングユーティリティのドキュメント化。