コードを貼って「全体として何をするか→主な流れ→1行ずつ」の順に説明してもらうと、理解しやすくなります。自分のレベル(初心者・経験者)を伝えると、ちょうどよい説明になります。
説明の頼み方いろいろ
| 目的 | 頼み方 |
|---|---|
| 全体像 | 「このコードが何をするか、3行で」 |
| 流れ | 「処理の流れを、箇条書きの手順で」 |
| 細かく | 「1行ずつ、初心者向けに。専門用語には説明を」 |
| 図にする | 「関数同士の呼び出し関係を図(Mermaid形式)で」 |
| 注意点 | 「このコードを変更するとき、壊れやすい所は?」 |
| コメント | 「各行に日本語のコメントを付けたコードにして」 |
会社のコードや、契約で公開が制限されているコードは、入力してよいか社内ルールを確認しましょう(社外秘を入力してもいい?)。説明が正しいとは限らないため、実際に動かして確かめることも大切です。