【リーダブルコード】宣言はブロックごとに整理する

※ 下記のリンクにある本の韓国語版を読んで簡単に整理しました。
https://www.amazon.co.jp/Art-Readable-Code-Practical-Techniques-ebook/dp/B0064CZ1XE

良いソースコードは「目に優しく」あるべきだ。

以下の3つの原則を強調しています。

1. 読み手にとって馴染みがあり、一貫性のあるレイアウトを使うこと
2. 似たようなコードは、見た目も似せること
3. 関連するコードは一つのブロックにまとめること

---

宣言はブロックごとに整理する

Server クラスにおけるコメント機能の整理例が紹介されています。
改善前のコードでは、機能の分類がされておらず、メソッドの意図を把握するのが難しい構成でした。

✖️ 改善前（Java版）

public class Server {
    public void createComment() {}
    public void openDatabase() {}
    public void updateComment() {}
    public void closeDatabase() {}
    public void replyComment() {}
    public void viewComment() {}
    public void commentNotFound() {}
    public void commentOK() {}
}

✔️ 改善後（Java版）

public class Server {

    // ハンドラー（コメント操作）
    public void viewComment() {}
    public void createComment() {}
    public void updateComment() {}
    public void replyComment() {}

    // クエリ／レスポンス ユーティリティ
    public void commentOK() {}
    public void commentNotFound() {}

    // データベース ヘルパー
    public void openDatabase() {}
    public void closeDatabase() {}
}

---

所感

この整理は、最初の引用文で言われている「関連するコードはひとつのブロックにまとめよ」という原則そのものです。
機能ごとにまとめることで、コード全体を一目で把握できるようになります。
一目で把握できるということは、バグを減らせる可能性が高くなるということでもあると感じました。

---

第4章の感想

第4章では、一貫したコーディング規約の遵守や、「まとめる」技術と「分ける」技術を通して、
コードを「一目で理解できる」ようにするための基本スキルが紹介されました。

ただ「並べる」のではなく、「整理・配置」する意識を持つことが、
読みやすさ・保守性・品質すべてにつながるということを、わかりやすい例で教えてくれる章でした。