理由を説明するコメントを書く
収録 2026-10-31
「何をしたか」のコメントを「なぜそうしたか」に変え、変更可否を判断できるようにします。
コードと既存コメントを渡します。1）コードの動作を言い換えただけのコメントを指摘；2）残すべき情報は「なぜそうしたか」（制約・トレードオフ・過去の障害）に書き換え；3）各行二行以内；4）後任が最も誤って変更しやすい箇所を一つ示し、注意を一文。ロジックは変えない。
当サイトオリジナル
中国語の原文
使い方
好注释解释取舍，不解释语法。
こう変えてみる
- コードを書く前に要件と制約を復唱させる。
- 全体書き換えではなく、最小の変更とロールバック方法を出させる。
得られる成果物
- そのまま使える最小変更（コピー可能なコード）
- 影響範囲：変更ファイルと追従が必要な呼び出し元
よくある失敗
- 一度に十ファイル変更させ、何が原因か分からなくなる。
- エラーだけ貼ってコードとバージョンを省くと、使えない修正が返る。
出力のチェック
- 変更は動いて戻せて、無関係なコードに手を入れていない。
- 境界条件（空・巨大・同時実行）が説明かテストで押さえられている。
使いどころと注意
- 向いている用途：要件と制約を復唱させてから、最小限の動く変更を出させる。
- 注意：エラーにはバージョンと最小再現を添える。無いと一見もっともらしいが合わない修正が返る。