【こーどれびゅー】
コードレビュー とは？
最終更新:
💡 コードの「他人の目による品質検査」
書いたコードを作成者以外の人が読み、設計・動作・テスト・分かりやすさなどを確認するプロセス。変更へのフィードバックを通して、コードの品質を改善する。
📌 このページのポイント
- 設計や動作、複雑さ、命名、テスト、文書などを確認する
- 変更部分だけでなく、周囲のコードとの関係も考える
- コメントは人への批判ではなく、コードの改善に向ける
- 理由と重要度を伝え、必須の修正と任意の提案を区別する
ひよこ コードレビューって怖くないの？
ペンギン先生 慣れるまでは批判されたように感じるかもしれないね。でも目的はコードを改善すること。コメントは人ではなくコードに向け、互いに丁寧に伝えよう。自分では気づかなかった点を、一緒に確認できる機会だよ。
ひよこ レビューで何を見ればいいの？
ペンギン先生 例えば設計や動作が目的に合うか、複雑すぎないか、名前が分かりやすいか、テストが重要な条件を確かめるかを見るよ。文書の更新も対象になる。セキュリティなど専門的な判断が必要なら、詳しい人に確認を頼むことも大切だね。
ひよこ コメントはどう書くといいの？
ペンギン先生 「なぜ気になるか」を説明し、必要なら改善案を添えよう。必須の修正か、任意の提案か、参考情報かも伝えると判断しやすいね。「Nit:」は細かな指摘を示す書き方の例で、すべてのチームに必須の記法ではないよ。
ひよこ レビューをもらったらどうすればいい？
ペンギン先生 求められた修正と、任意の提案を確認しよう。修正した内容や、違う考えがある理由を伝えて、認識を合わせると進めやすいね。分からないコメントは意図を聞いてみよう。すべての提案を無条件で採用する必要はないんだ。
まとめ：ざっくりこれだけ覚えればOK！
「コードレビュー」って出てきたら「コードの「他人の目による品質検査」」と思えばだいたいOK！
📖 おまけ：英語の意味
「code review」 ＝ コードの見直し・検査
💬 作成者以外の人がコードを確認することだよ。コメントを使ったやり取りのほか、その場で一緒に確認する方法もあるんだ。