3
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

リーダブルコードの本質をまとめてみた

「とりあえず動けばいい」という考え方が、どれほどのプロジェクトを遅延させ、どれほどのエンジニアを疲弊させてきたか

目の前のタスクを終わらせることに必死で、未来の自分やチームへの「配慮」を怠ったコードは、やがて巨大な技術的負債となり、開発速度を奪い、バグの温床と化し、保守運用をじわじわと苦しめます。

名著『リーダブルコード』は、単なるコーディング規約集ではない

それは、持続可能な開発を実現するためのプログラミングの哲学です。本記事では、自分が体験した現場のリアルな苦しみと向き合いながら、『リーダブルコード』の全15章(第4部まで含む)を「本質」と「アクション」の観点から整理して、アウトプットしてみました!

是非、最後までご覧ください!

1. そのコードは「負債」です

あなたはこんな経験はありませんか?

  • 「この機能、誰が作ったんだ…?」「あ、去年の俺だ…」と過去の自分を呪う。
  • ちょっとした修正が、予期せぬ場所でバグを引き起こし、デバッグに数日を要する。
  • 新機能開発よりも、既存コードの解読と保守に大半の時間を費やす。
  • コードレビューで「これ、どういう意図ですか?」の質問が飛び交い、本質的な議論ができない。

これらはすべて、「読みづらいコード」が引き起こす技術的負債の症状です。そして、その負債は時間と共に雪だるま式に膨れ上がり、やがてプロジェクト全体を破綻に導く可能性すらあります。

『リーダブルコード』は、この負債を未然に防ぎ、あるいは返済するための具体的な指針を与えてくれます。コードは他の人が最短時間で理解できるように書かれなければならないという、たった一つのシンプルな原則に集約されます。


2. 『リーダブルコード』全15章の処方箋:可読性を高める思考法

書籍の各章が伝えるエッセンスを、「本質」と「アクション」というシンプルな形式で再構築しました。これらは単なるテクニックではなく、コードを書く際の「心の姿勢、思想」そのものです。
意識しておくだけで、あなたのコードの可読性は飛躍的に向上していきます!

第1部:表面上の改善

第1章 理解しやすいコード

本質: コードは「動く」だけでは不十分。それは「コミュニケーションツール」である。

アクション: コードを書く前に「このコードを読んだ人が、何に疑問を持つだろうか?」と自問自答し、その疑問を先回りして解消するようなコードを目指す。

NG / OK コード:

# NG: 意図が不明瞭
def process(data):
    # 複雑な処理
    return result

# OK: 意図が明確な関数名とコメント
def calculate_monthly_sales_report(raw_sales_data):
    # 月次売上レポートを集計目的で生成する
    return monthly_report

第2章 名前に情報を詰め込む

本質: 名前は「コードの顔」。その一言で全てを語らせよ。

アクション: 変数や関数名に、その役割、目的、含まれる情報の種類を明確に伝える言葉を選ぶ。単位や状態も名前に含める。

NG / OK コード:

# NG: 抽象的で情報が少ない
def get_data(url):
    ...

# OK: 具体的な動作と対象を明示
def fetch_user_profile(user_id):
    ...

def download_image_from_url(image_url):
    ...

# NG: 単位が不明
delay = 1000

# OK: 単位を明示
delay_ms = 1000

第3章 誤解されない名前

本質: 曖昧さはバグの温床。名前は「唯一の解釈」を持つべきだ。

アクション: 複数の意味を持つ単語を避け、具体的な動作を表現する。特に境界値の扱いは命名規則で一貫した意味を持たせる。

NG / OK コード:

# NG: 曖昧な動詞
def filter_list(items):
    # 何をフィルタリングするのか不明
    ...

# OK: 具体的な動作を表現
def exclude_invalid_items(items):
    ...

# NG: 境界値の解釈が不明瞭
start = 0
end = 10
# endが含まれるのか含まれないのか?

# OK: 命名規則で一貫した意味を持たせる
first_index = 0  # 含む
last_index = 9   # 含む

start_offset = 0 # 含む
end_offset = 10  # 含まない

第4章 美しさ

本質: コードの美しさは「読みやすさ」に直結する。それは単なる好みではない。

アクション: フォーマッターを導入し、コードスタイルを自動的に統一する。似たようなコードは似たように見せ、チーム全体で一貫したスタイルを保つ。

NG / OK コード:

# NG: インデント、スペース、改行がバラバラ
def func(arg1,arg2):  
 if arg1 > 0: return arg2+1
 else: return arg2-1

# OK: フォーマッターで統一されたスタイル
def func(arg1, arg2):
    if arg1 > 0:
        return arg2 + 1
    else:
        return arg2 - 1

第5章 コメントの原則

本質: コードが「何を」しているかは書くな。「なぜ」そうしているかを書け。

アクション: コードの意図、背景、特定の制約、将来の課題など、「なぜ」の部分をコメントに残す。コードからわかることはコメントしない。

NG / OK コード:

# NG: コードを見ればわかることの繰り返し
# ユーザーの年齢が18歳以上かチェックする
if user.age >= 18:
    ...

# OK: 意図や背景を説明
# 法律により、この機能は18歳以上のユーザーにのみ提供される
if user.age >= 18:
    ...

# OK: 将来の課題を明示
# TODO: この処理はパフォーマンスボトルネックになる可能性があるため、非同期処理に移行を検討

第6章 読みやすいコメント

本質: コメントもまたコードの一部。その品質がコードの寿命を決める。

アクション: コメントは簡潔で正確に。常に最新の状態に保ち、コードの理解を助ける最小限の情報に留める。

NG / OK コード:

# NG: 古い情報や冗長なコメント
# この関数はv1.0で追加された。ユーザーデータを取得し、
# データベースに保存する前にバリデーションを行う。
# (現在はバリデーションは別の層で行われている)
def get_and_save_user_data(user_id):
    ...

# OK: 簡潔で正確なコメント
# ユーザーデータを取得し、DBに保存する。
# バリデーションは呼び出し元で完了している前提。
def get_and_save_user_data(user_id):
    ...

第2部:ループとロジックの単純化

第7章 制御フローを読みやすくする

本質: ネストは「思考の迷宮」。浅ければ浅いほど、バグは隠れにくい。

アクション: ガード節(早期リターン)を積極的に使い、ネストを浅く保つ。条件式は「左に調査対象、右に比較対象」を置く。

NG / OK コード:

// NG: 深いネスト
function processOrder(order) {
    if (order.isValid()) {
        if (order.hasItems()) {
            if (order.customer.isPremium()) {
                // プレミアム顧客の注文処理
            } else {
                // 通常顧客の注文処理
            }
        } else {
            // アイテムがない場合の処理
        }
    } else {
        // 無効な注文の処理
    }
}

// OK: ガード節でネストを解消
function processOrder(order) {
    if (!order.isValid()) {
        handleInvalidOrder();
        return;
    }
    if (!order.hasItems()) {
        handleNoItemsOrder();
        return;
    }

    if (order.customer.isPremium()) {
        processPremiumOrder();
    } else {
        processNormalOrder();
    }
}

第8章 巨大な式を分割する

本質: 複雑な思考は「言葉」に分解せよ。コードは思考の軌跡である。

アクション: 説明変数を導入し、中間結果や条件の意味を明確な言葉で表現する。これにより、コードが思考のプロセスを語り始める。

NG / OK コード:

# NG: 一見して意図不明な巨大な式
if (user.age > 18 and user.country == "JAPAN") or (user.is_admin and user.has_special_privilege):
    process_special_user()

# OK: 説明変数で思考を分解
is_adult_japanese = (user.age > 18 and user.country == "JAPAN")
is_privileged_admin = (user.is_admin and user.has_special_privilege)

if is_adult_japanese or is_privileged_admin:
    process_special_user()

第9章 変数と可読性

本質: 変数は「状態」を保持する。その状態が不安定なら、コードも不安定になる。

アクション: 変数のスコープを最小限に保ち、可能な限りconstfinalで再代入を防ぐ。変数は「一度だけ書き込む」ことで、コードの信頼性を高める。

NG / OK コード:

// NG: スコープが広く、いつ変更されるか不明
let total = 0;
for (let i = 0; i < items.length; i++) {
    total += items[i].price;
}
// totalがこの後も使われるのか、変更されるのか不明瞭

// OK: スコープを限定し、不変性を意識
const calculateTotalPrice = (items) => {
    let sum = 0;
    for (const item of items) {
        sum += item.price;
    }
    return sum;
};
const totalPrice = calculateTotalPrice(orderItems);
// totalPriceは不変であることが明確

第3部:コードの再構成

第10章 無関係な下位問題を抽出する

本質: コードは「物語」である。脇役は脇役の役割に徹させよ。

アクション: 特定のビジネスロジックとは関係ない汎用的な処理を、独立した関数やモジュールとして切り出す。これにより、メインのロジックがシンプルになり、再利用性も高まる。

NG / OK コード:

# NG: メインロジックに汎用処理が混在
def process_report(data):
    # データをCSV形式に変換するロジック
    csv_data = convert_to_csv(data)
    # CSVファイルを保存するロジック
    with open("report.csv", "w") as f:
        f.write(csv_data)
    # レポート生成のメインロジック
    ...

# OK: 汎用処理を関数として抽出
def convert_to_csv(data):
    # ... CSV変換ロジック ...
    return csv_data

def save_file(filename, content):
    with open(filename, "w") as f:
        f.write(content)

def process_report(data):
    csv_data = convert_to_csv(data)
    save_file("report.csv", csv_data)
    # レポート生成のメインロジック
    ...

第11章 一度に一つのことを

本質: その関数は「多重人格」ではないか?役割は一つに絞れ。

アクション: 関数やメソッドが複数のタスクを同時にこなしていないか確認し、タスクを1つずつ順番に処理するように構成を書き換える。

NG / OK コード:

# NG: 複数の役割を持つ関数
def process_user_data(user_id):
    # ユーザーデータをDBから取得
    user = db.get_user(user_id)
    # ユーザーデータをバリデーション
    if not validate_user(user):
        raise ValueError("Invalid user")
    # ユーザーデータを更新
    db.update_user(user)
    # ユーザーに通知メールを送信
    send_notification_email(user)

# OK: 役割を分割した関数
def get_user(user_id):
    return db.get_user(user_id)

def validate_user(user):
    # ... バリデーションロジック ...
    return True

def update_user(user):
    db.update_user(user)

def send_notification_email(user):
    # ... メール送信ロジック ...
    pass

def handle_user_update_flow(user_id):
    user = get_user(user_id)
    if not validate_user(user):
        raise ValueError("Invalid user")
    update_user(user)
    send_notification_email(user)

第12章 コードに思いを込める

本質: コードは「意図」を表現する。自然言語で語れるロジックをコードにせよ。

アクション: 複雑なロジックを書く前に、まずコメントや擬似コードで自然言語でその処理を記述する。その記述がそのままコードに変換できるような、シンプルで明確なロジックを目指す。

NG / OK コード:

# NG: 意図が読み取りにくいロジック
def calculate_discount(price, quantity, is_member, is_first_purchase):
    if is_member and quantity > 5:
        return price * 0.1
    elif is_first_purchase:
        return price * 0.05
    return 0

# OK: 意図を明確にする説明変数と構造
def calculate_discount(price, quantity, is_member, is_first_purchase):
    member_discount_eligible = is_member and quantity > 5
    first_purchase_discount_eligible = is_first_purchase

    if member_discount_eligible:
        return price * 0.1  # 会員かつ大量購入割引
    elif first_purchase_discount_eligible:
        return price * 0.05 # 初回購入割引
    return 0

第13章 短いコードを書く

本質: コードは「資産」であると同時に「負債」でもある。不要なものは捨て去れ。

アクション: 不要な機能や冗長な処理は削除する。既存のライブラリやフレームワークの機能を最大限に活用し、車輪の再発明を避ける。

NG / OK コード:

# NG: 手動での実装(既存機能の再発明)
def sort_numbers(numbers):
    # バブルソートの実装
    n = len(numbers)
    for i in range(n):
        for j in range(0, n-i-1):
            if numbers[j] > numbers[j+1]:
                numbers[j], numbers[j+1] = numbers[j+1], numbers[j]
    return numbers

# OK: 既存ライブラリの活用
def sort_numbers(numbers):
    return sorted(numbers)

第4部:選抜されたトピック

第14章 テストと可読性

本質: テストコードは「仕様書」である。その仕様書が読めなければ、誰も使わない。

アクション: テストの命名規則を明確にし、テスト対象の機能と期待される結果がすぐにわかるようにする。テストデータは最小限に抑え、テストケースごとに独立させる。

NG / OK コード:

# NG: テスト名が抽象的で意図不明
def test_calc():
    assert calculate(1, 2) == 3
    assert calculate(5, 0) == 5

# OK: テスト名で仕様を表現 (Given-When-Then)
def test_calculate_sum_of_two_positive_numbers():
    # Given: 2つの正の数
    num1 = 1
    num2 = 2
    # When: 合計を計算する
    result = calculate_sum(num1, num2)
    # Then: 正しい合計が返される
    assert result == 3

def test_calculate_sum_with_zero():
    # Given: 0を含む数
    num1 = 5
    num2 = 0
    # When: 合計を計算する
    result = calculate_sum(num1, num2)
    # Then: 正しい合計が返される
    assert result == 5

第15章 ドメイン固有言語

本質: コードは「専門用語」を話すべきだ。しかし、それはチーム全員が理解できる言葉で。

アクション: 業務知識を持つメンバーと連携し、共通の言語(ユビキタス言語)を定義する。その言語をコードの命名や構造に反映させる。

NG / OK コード:

# NG: 業務ロジックが汎用的な言葉で表現され、意図が伝わりにくい
def process_items(items):
    for item in items:
        if item.status == 1 and item.type == "A":
            # 処理A
        elif item.status == 2 and item.type == "B":
            # 処理B

# OK: ドメイン固有の言葉でロジックを表現
class OrderStatus:
    PENDING = 1
    SHIPPED = 2

class ItemType:
    PHYSICAL = "A"
    DIGITAL = "B"

def process_order_items(order_items):
    for item in order_items:
        if item.status == OrderStatus.PENDING and item.type == ItemType.PHYSICAL:
            handle_physical_item_pending(item)
        elif item.status == OrderStatus.SHIPPED and item.type == ItemType.DIGITAL:
            handle_digital_item_shipped(item)

第16章 プロジェクトを良くしていく

本質: リーダブルコードは「旅」である。終わりなき改善のプロセスを受け入れよ。

アクション: 定期的なコードレビューを通じて、リーダブルコードの原則が守られているかを確認し、フィードバックし合う。新しいメンバーが加わった際には、リーダブルコードの重要性を伝え、文化として浸透させる努力を惜しまない。

NG / OK コード:

# NG: 改善活動が単発で終わる、あるいは全く行われない
# (コード例で表現するのは難しいが、意識の問題)

# OK: 継続的な改善と文化の醸成
# コードレビューで「なぜこの命名にしたのか?」を議論する
# 新規参画者向けにリーダブルコードのガイドラインを共有する
# 技術ブログでリーダブルコードに関する知見を共有する

まとめ:読みやすいコードは、開発保守をラクになる

リーダブルコードは、単なる「きれいなコード」を書くための技術ではありません。それは、未来の自分やチームへの思いやりであり、持続可能なプロジェクト運営のための必須スキルです。

あなたの書いたコードは、未来の誰か(あるいは未来のあなた自身)が読むことになります。感謝と共に読まれるか、それとも呪詛と共に読まれるか。それは、今日のあなたの選択にかかっています。

さあ、今日から「未来の自分たちを苦しめないコード」を書き始めましょう。


『リーダブルコード』目次と書籍情報

本書のより詳細な内容は、ぜひ原著を手にとってご確認ください。各章が、あなたのコードをより良くするための具体的なヒントを与えてくれます。

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック

目次

  • 第1部 表面上の改善
    • 第1章 理解しやすいコード
    • 第2章 名前に情報を詰め込む
    • 第3章 誤解されない名前
    • 第4章 美しさ
    • 第5章 コメントの原則
    • 第6章 読みやすいコメント
  • 第2部 ループとロジックの単純化
    • 第7章 制御フローを読みやすくする
    • 第8章 巨大な式を分割する
    • 第9章 変数と可読性
  • 第3部 コードの再構成
    • 第10章 無関係な下位問題を抽出する
    • 第11章 一度に一つのことを
    • 第12章 コードに思いを込める
    • 第13章 短いコードを書く
  • 第4部 選抜されたトピック
    • 第14章 テストと可読性
    • 第15章 ドメイン固有言語
    • 第16章 プロジェクトを良くしていく
3
5
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?