レビューコメントは、コードの書き手を評価する文章ではありません。変更を安全で理解しやすい状態へ近づける会話です。
コメントの4要素
観察: 失敗時にも200を返しています。
影響: 呼び出し側が成功と失敗を区別できません。
提案: 入力エラーは400で返す案はどうでしょうか。
確認: 既存クライアントが200を前提にしていないか確認したいです。
強さを示す
- 必須: セキュリティ、データ破損、仕様違反
- 提案: 保守性や読みやすさの改善
- 質問: 意図や前提の確認
- 細部: 表記や好み
重要度が分かると、書き手は対応順を判断できます。
人ではなく変更を見る
「理解していない」ではなく「この名前から単位を判断できない」と書きます。断定できない時は質問にします。
良いレビューは、直す場所だけでなく、なぜ直すかを次の変更にも残します。
次に読む記事
← 一覧に戻るPR
PR
