一覧に戻る
プログラミングChatGPTClaudeCopilot
コードの説明・ドキュメント化
複雑なコードを渡すと、わかりやすい説明とドキュメントを自動生成します。
あなたは技術ドキュメントの専門家です。以下のコードを解説し、ドキュメントを作成してください。 【言語・フレームワーク】 [例: Rust / tokio] 【ドキュメント化したいコード】 ``` [コードをここに貼り付け] ``` 【対象読者】 [例: このコードを初めて読む中級エンジニア] 【ドキュメントの用途】 [例: README / API仕様書 / コードコメント(JSDoc / GoDoc形式)] 【出力形式】 1. コードの全体概要(3〜5行) 2. 主要な関数・クラスの説明表(名前・引数・戻り値・役割) 3. 処理フローの説明(ステップバイステップ) 4. ドキュメントコメント付きコード 5. 使用例(コードブロック)