概要
Copilot は既存コードを解析して JSDoc・Docstring・Markdown などのドキュメントを自動生成できます。ドキュメント整備の工数を大幅に削減できます。
ドキュメント生成の手順
- ドキュメントを付けたい関数の直前の行にカーソルを置く
/**（JSDoc）または"""（Python）を入力すると自動補完が始まる- Copilot Chat で関数を選択して「JSDoc コメントを生成して」と指示する方法も有効
- モジュール全体のドキュメントは
/explainの結果を README に転用する - 型情報・引数説明・使用例が含まれているか確認して必要に応じて補足
活用シーンと応用
- レガシーコードの一括ドキュメント化に特に威力を発揮する
- 「使用例（@example）を含めて」と指示するとサンプルコードも生成される
- 生成したドキュメントから自動的に API リファレンスサイトを作成するツールと組み合わせると効果的