「綺麗なコード vs 汚いコードの違いとは?初心者が押さえるべき7つのポイントを徹底解説!」
こんにちは。ゆうせいです。
今回は「綺麗なコード」と「汚いコード」の違いについて解説していきます。
プログラミング初心者の方の中には、
- 「動けばいいんじゃないの?」
- 「なんでコードの書き方にうるさいの?」
と思っている方もいるかもしれません。
ですが、綺麗なコードはバグが少なく、チームでも読みやすく、保守も簡単になるという大きなメリットがあるんです!
この記事では、コメントアウトの有無ではなく、コードの構造や書き方そのものに注目していきます。
綺麗なコードとは何か?
まず、定義からいきましょう。
綺麗なコードの特徴:
- 意図がすぐに読み取れる
- 短すぎず長すぎない
- 無駄がない
- 規則性がある
- チームのルールに従っている
つまり「他人が読んでもすぐに理解できる」コードです。
綺麗なコード vs 汚いコード:7つのチェックポイント
1. ループの選び方:for文と拡張for文の使い分け
【悪い例】
for (int i = 0; i < list.size(); i++) {
System.out.println(list.get(i));
}
【良い例】
for (String item : list) {
System.out.println(item);
}
解説:
インデックスが必要ないときは、拡張for文(for-each)を使うとコードが簡潔で読みやすくなります。
「何を繰り返してるか」が一目でわかりますね!
2. 変数名が意味を持っているか?
【悪い例】
int a = 10;
int b = 20;
int c = a + b;
【良い例】
int itemPrice = 10;
int tax = 20;
int totalPrice = itemPrice + tax;
解説:
変数名には「意味」が込められているべきです。
「a + b = c」だと、何が何だかわかりませんよね。
3. 一つの関数に多くの処理を詰め込んでいないか?
【悪い例】
void processOrder() {
// 商品読み込み
// 在庫チェック
// 支払い処理
// メール送信
}
【良い例】
void processOrder() {
loadItems();
checkStock();
processPayment();
sendConfirmationMail();
}
解説:
関数(メソッド)は一つの目的に絞るのが基本です!
機能ごとに分けることで、保守性がアップし、テストしやすくなります。
4. コードの行数が多い?少ない?
- 行数が多すぎるコード:冗長になり、何をしているか分かりにくい
- 行数が少なすぎるコード:処理を詰め込みすぎて、逆に読みづらい
【極端な悪い例】
if(x>0){doSomething();}else{doSomethingElse();}
【良い例】
if (x > 0) {
doSomething();
} else {
doSomethingElse();
}
解説:
コードは「詰めすぎず、間延びしすぎず」適度な改行とインデントが大事です。
5. 定数・マジックナンバーの扱い
【悪い例】
if (score > 60) {
// 合格
}
【良い例】
final int PASS_SCORE = 60;
if (score > PASS_SCORE) {
// 合格
}
解説:
マジックナンバー(数字だけ書かれた謎の値)は極力避けましょう。意味を持たせることで意図が明確になります。
6. 一貫性のあるスタイルを保っているか?
- 大文字・小文字のルール
- インデント(タブ or スペース)
- 波かっこの位置
すべてが統一されていないと、読み手は混乱します。
【悪い例】
int Price;
if(price>0){
System.out.println("OK");
}
【良い例】
int price;
if (price > 0) {
System.out.println("OK");
}
7. 冗長な条件分岐や処理をしていないか?
【悪い例】
if (isAvailable == true) {
return true;
} else {
return false;
}
【良い例】
return isAvailable;
解説:
無駄なif文やreturn文を削るだけで、コードがすっきりします!
綺麗なコードを書くメリット
項目 | メリット |
---|---|
保守性 | 後から修正しやすい |
再利用性 | 似たコードが簡単に使い回せる |
バグの発見 | 構造が整理されていて見つけやすい |
チーム作業 | 他の人が読みやすい |
まとめ:綺麗なコードを書くために意識すべきこと
- 短くてもわかりやすいコードを目指す
- 拡張for文や関数の分割を積極的に使う
- 無駄をなくし、意味を込める
- 見た目の整理も重要なスキル!
今後の学習の指針
綺麗なコードは「センス」ではなく「訓練」で身につきます。
次に学ぶとよい内容としては以下があります:
- クリーンコード(Clean Code)という本を読む
- リファクタリングの練習
- コードレビューを受けてみる
- コーディング規約(コーディングスタイル)を確認する
セイ・コンサルティング・グループの新人エンジニア研修のメニューへのリンク
投稿者プロフィール
