Robert C. Martin (Uncle Bob) Clean Code ベストプラクティス

Robert C. Martin の「Clean Code: A Handbook of Agile Software Craftsmanship」に基づく包括的なソフトウェア職人技ガイドです。2008 年の元々の助言が時代遅れになった部分については現代的な修正を加えています。10 のカテゴリにわたる 48 のルールを含み、影響度で優先順位付けされており、コードレビュー、リファクタリング判断、新規開発を指導します。例はおもに Java ですが、原則はプログラミング言語に依存しません。

適用のタイミング

以下の場合にこのガイドラインを参照してください:

• 新しい関数、クラス、またはモジュールを記述する
• 変数、関数、クラス、またはファイルに名前を付ける
• 保守性の問題がないかコードをレビューする
• 既存コードをリファクタリングして明確性を改善する
• ユニットテストを記述または改善する
• サードパーティの依存関係をラップする

ルールカテゴリを優先度別に表示

優先度	カテゴリ	影響度	プレフィックス
1	意味のある名前	CRITICAL	name-
2	関数	CRITICAL	func-
3	コメント	HIGH	cmt-
4	フォーマット	HIGH	fmt-
5	エラーハンドリング	HIGH	err-
6	オブジェクトとデータ構造	MEDIUM-HIGH	obj-
7	バウンダリ	MEDIUM-HIGH	bound-
8	クラスとシステム	MEDIUM-HIGH	class-
9	ユニットテスト	MEDIUM	test-
10	出現と単純設計	MEDIUM	emerge-

クイックリファレンス

1. 意味のある名前 (CRITICAL)

• name-intention-revealing - 意図を表す名前を使用する
• name-avoid-disinformation - 誤解を招く名前を避ける
• name-meaningful-distinctions - 意味のある区別を作る
• name-pronounceable - 発音しやすい名前を使用する
• name-searchable - 検索可能な名前を使用する
• name-avoid-encodings - 名前にエンコーディングを避ける
• name-class-noun - クラス名に名詞句を使用する
• name-method-verb - メソッド名に動詞句を使用する

2. 関数 (CRITICAL)

• func-small - 関数を小さく保つ
• func-one-thing - 関数は 1 つのことだけを行う
• func-abstraction-level - 1 段階の抽象化を維持する
• func-minimize-arguments - 関数の引数を最小化する
• func-no-side-effects - 副作用を避ける
• func-command-query-separation - コマンドとクエリを分離する
• func-dry - 繰り返しを避ける

3. コメント (HIGH)

• cmt-express-in-code - コメントではなくコードで表現する
• cmt-explain-intent - コメントを使用して意図を説明する
• cmt-avoid-redundant - 冗長なコメントを避ける
• cmt-avoid-commented-out-code - コメントアウトされたコードを削除する
• cmt-warning-consequences - 警告コメントで結果を示す

4. フォーマット (HIGH)

• fmt-vertical-formatting - 可読性のための垂直フォーマットを使用する
• fmt-horizontal-alignment - 水平配置を避ける
• fmt-team-rules - チームのフォーマットルールに従う
• fmt-indentation - インデンテーションルールを守る

5. エラーハンドリング (HIGH)

• err-use-exceptions - エラーハンドリングを正常系パスから分離する
• err-write-try-catch-first - try-catch-finally を最初に記述する
• err-provide-context - 例外にコンテキストを提供する
• err-define-by-caller-needs - 呼び出し元のニーズで例外を定義する
• err-avoid-null - null の返却と受け渡しを避ける

6. オブジェクトとデータ構造 (MEDIUM-HIGH)

• obj-data-abstraction - データを抽象化の背後に隠す
• obj-data-object-asymmetry - データ/オブジェクトの非対称性を理解する
• obj-law-of-demeter - Law of Demeter に従う
• obj-avoid-hybrids - ハイブリッドなデータ/オブジェクト構造を避ける
• obj-dto - データ転送に DTO を使用する

7. バウンダリ (MEDIUM-HIGH)

• bound-wrap-third-party - サードパーティ API をラップする
• bound-learning-tests - サードパーティコードの学習テストを記述する

8. クラスとシステム (MEDIUM-HIGH)

• class-small - クラスを小さく保つ
• class-cohesion - クラスの凝集度を維持する
• class-organize-for-change - クラスを変更に対応するように構成する
• class-isolate-from-change - クラスを変更から隔離する
• class-separate-concerns - 構築と使用を分離する

9. ユニットテスト (MEDIUM)

• test-first-law - TDD の 3 つの法則に従う
• test-keep-clean - テストをクリーンに保つ
• test-one-assert - テストごとに 1 つのコンセプト
• test-first-principles - FIRST 原則に従う
• test-build-operate-check - Build-Operate-Check パターンを使用する

10. 出現と単純設計 (MEDIUM)

• emerge-simple-design - 単純設計の 4 つのルールに従う
• emerge-expressiveness - 表現性を最大化する

使い方

詳細説明とコード例については、個別のリファレンスファイルを読んでください:

• セクション定義 - カテゴリ構造と影響度レベル
• ルールテンプレート - 新しいルールを追加するためのテンプレート

リファレンスファイル

ファイル	説明
references/_sections.md	カテゴリ定義と順序付け
assets/templates/_template.md	新しいルール用のテンプレート
metadata.json	バージョンとリファレンス情報