readability|読みやすさはコードの第一品質
readability|読みやすさはコードの第一品質
概要
readability
(可読性)は、コードレビューで最も頻出する評価軸です。
「書いた人だけが分かるコード」ではなく、「他人がすぐ理解できるコード」にすることが、品質・速度・安全性すべてに直結します。
バグの多くは「読みにくさ」に起因します。readabilityの改善は予防線です。
可読性の判断ポイント
観点 | 評価ポイント |
---|---|
命名 | 意図が明確か。略語や意味不明な単語は避けられているか |
コメント | 補足が要るほど複雑な処理になっていないか |
ネスト | 入れ子が深すぎないか。早期returnで簡潔にできるか |
一貫性 | 命名・順序・文法・インデントが統一されているか |
分割 | 1関数の責任が多すぎないか(分割対象か) |
「読みやすさ」は主観に見えても、ある程度客観化された判断軸を持てばチームで共有できます。
before/afterで見る可読性の改善
Before(読みにくい)
function fn(d){if(d.a){return d.b}}else{return null}
After(読みやすい)
function getDataOrNull(data) {
if (!data.a) return null;
return data.b;
}
命名とインデントだけで、処理意図が3秒で理解できるようになります。
コメントと可読性の関係
- 「コメントを書かないと伝わらない処理」は読みやすいコードではない
- コメントは「なぜ」を書く、コードは「何を」を示す
- 読み手が迷う箇所には意図を添える(例:一見無意味に見える定数など)
// ユーザーIDが-1のときは未ログイン状態
if (userId === -1) return false;
会話例:readabilityを巡る指摘
Reviewer: この処理、意図は分かるんですがifが入れ子で読みにくいかもです。
Author: 確かに…guard節で分けてみます。
Reviewer: コメントが詳細ですが、そもそも関数名を明確にすると不要になる気がします。
Author: 納得です。命名と責務見直します。
可読性の高いコードの特徴
- 目を通した瞬間に「何をしているか」が分かる
- 順を追って読む必要がない(文脈が短く済む)
- 書いた人が半年後に読んでも理解できる
- 仕様変更・不具合修正時に迷いが生じにくい
自分の書いたコードを「レビューするつもりで読む」習慣が可読性を磨く近道です。
関連用語
実務視点まとめ
readabilityは「正しく動くか」以前に「理解できるか」を問う視点です。
優れたコードは、未来のメンバーの時間と信頼を守ります。レビューでも実装でも、読まれることを前提に書くという視点を常に持ちましょう。
title: readability|読みやすさはコードの第一品質 description: 「readability(可読性)」はコードレビューで最も重視される観点の一つ。読みやすさが保守性・バグ発見・開発速度にどう影響するか、実例と共に徹底解説。 tags: [コードレビュー, readability, 可読性, コーディングスタイル, コメント, 命名]
readability|読みやすさはコードの第一品質
概要
readability
(可読性)は、コードレビューで最も頻出する評価軸です。
「書いた人だけが分かるコード」ではなく、「他人がすぐ理解できるコード」にすることが、品質・速度・安全性すべてに直結します。
バグの多くは「読みにくさ」に起因します。readabilityの改善は予防線です。
可読性の判断ポイント
観点 | 評価ポイント |
---|---|
命名 | 意図が明確か。略語や意味不明な単語は避けられているか |
コメント | 補足が要るほど複雑な処理になっていないか |
ネスト | 入れ子が深すぎないか。早期returnで簡潔にできるか |
一貫性 | 命名・順序・文法・インデントが統一されているか |
分割 | 1関数の責任が多すぎないか(分割対象か) |
「読みやすさ」は主観に見えても、ある程度客観化された判断軸を持てばチームで共有できます。
before/afterで見る可読性の改善
Before(読みにくい)
function fn(d){if(d.a){return d.b}}else{return null}
After(読みやすい)
function getDataOrNull(data) {
if (!data.a) return null;
return data.b;
}
命名とインデントだけで、処理意図が3秒で理解できるようになります。
コメントと可読性の関係
- 「コメントを書かないと伝わらない処理」は読みやすいコードではない
- コメントは「なぜ」を書く、コードは「何を」を示す
- 読み手が迷う箇所には意図を添える(例:一見無意味に見える定数など)
// ユーザーIDが-1のときは未ログイン状態
if (userId === -1) return false;
会話例:readabilityを巡る指摘
Reviewer: この処理、意図は分かるんですがifが入れ子で読みにくいかもです。
Author: 確かに…guard節で分けてみます。
Reviewer: コメントが詳細ですが、そもそも関数名を明確にすると不要になる気がします。
Author: 納得です。命名と責務見直します。
可読性の高いコードの特徴
- 目を通した瞬間に「何をしているか」が分かる
- 順を追って読む必要がない(文脈が短く済む)
- 書いた人が半年後に読んでも理解できる
- 仕様変更・不具合修正時に迷いが生じにくい
自分の書いたコードを「レビューするつもりで読む」習慣が可読性を磨く近道です。
関連用語
実務視点まとめ
readabilityは「正しく動くか」以前に「理解できるか」を問う視点です。
優れたコードは、未来のメンバーの時間と信頼を守ります。レビューでも実装でも、読まれることを前提に書くという視点を常に持ちましょう。