オーバーロード関数のJSDoc

関数オーバーロードのドキュメント化

TypeScriptの関数オーバーロードは、関数が異なるパラメータ型を受け取り、異なる型を返すことを可能にします。各オーバーロードシグネチャは個別にドキュメント化する必要があります。

シグネチャの例

function parse(input: string): JsonObject;
function parse(input: Buffer): JsonObject;
function parse(input: string | Buffer, encoding?: string): JsonObject;

ドキュメント戦略

1. 各オーバーロードをドキュメント化: 各シグネチャに独自のコメントブロック
2. 実装シグネチャ: 最後の（実装）シグネチャに包括的なコメント
3. 具体的に: 各オーバーロードコメントはそのパラメータ型に固有の動作を説明

TSDocアプローチ

TSDocはオーバーロードシグネチャのみをドキュメント化することを推奨します（実装は不要）。実装シグネチャは消費者には見えないためです。