JSDoc / TSDocジェネレーター

JSDocは型アノテーションを波括弧で含みます（例：@param {string} name）。JavaScriptには型システムがないためです。TSDocはTypeScriptが型システムを提供するためインライン型を省略し、@param nameで十分です。TSDocはジェネリック型パラメータに@templateの代わりに@typeParamを使用します。このツールは1つのトグルで両方のスタイルをサポートしています。

パーサーは通常の関数宣言（function foo()）、アロー関数（const foo = () => {}）、非同期関数、エクスポートされた関数、クラス宣言、インターフェース宣言、メソッドシグネチャ、ジェネリック型パラメータ、残余パラメータ、オプションパラメータ、デフォルト値、分割代入パラメータを処理します。パーサーが複雑なシグネチャを処理できない場合は、マニュアルモードを使用してください。

はい。クラスまたはインターフェース宣言を貼り付けると、ツールが適切なコメントブロックを生成します。マニュアルモードで種類として「Class」や「Interface」を選択することもできます。

いいえ。ツールは文字列操作と正規表現を使用してシグネチャのテキストのみを解析します。eval()やコードの実行は行いません。ASTパーサーやコンパイラは読み込まれません。解析は純粋に構文的です。

はい。すべての処理はJavaScriptを使用してブラウザ内で完全に実行されます。コード、関数シグネチャ、生成されたドキュメントがサーバーに送信されることはありません。ツール使用中にブラウザの開発者ツールのネットワークタブで確認できます。

マニュアルモードでは、各パラメータにDescriptionフィールドがあり、カスタム説明を入力できます。パースモードでは、生成されたコメントに「TODO: describe parameter」プレースホルダーが使用されるので、コードエディターで実際の説明に置き換えてください。

はい。'function MyComponent(props: { title: string; count: number }): JSX.Element'や'const MyComponent: React.FC<Props> = ...'のようなReact関数コンポーネントシグネチャを貼り付けると、propsの@paramタグ付きの適切なドキュメントが生成されます。