Dustin Boswell氏の著書
「The Art of Readable Code: Simple and Practical Techniques for Writing Better Code」
がとても参考になったのでメモしておきます。
以下の内容が書かれています。
プログラミングに携わる人は、読んで損はない内容です。
1 理解しやすいコード／CODE SHOULD BE EASY TO UNDERSTANDING
- 「優れた」コードって何？／What Makes Code “Better”?
- 読みやすさの基本定理／The Fundamental Theorem of Readability
- 小さなものは絶対にいいこと？／Is Smaller Always Better?
- 「理解するまでにかかる時間」は競合する？／Does Time-Till-Understanding Conflict with Other Goals?
- ハードパート／The Hard Part
Part1：表面上の改善／SURFACE-LEVEL IMPROVEMENTS
2 名前に情報を埋め込む／PACKING INFORMATION INTO NAMES
- 明確な単語を選ぶ／Choose Specific Words
- tmpやretval のような汎用的な名前を避ける／Avoid Generic Names Like tmp and retval
- 抽象的な名前よりも具体的な名前を使う／Prefer Concrete Names over Abstract Names
- 名前に情報を追加する／Attaching Extra Information to a Name
- 名前の長さを決める／How Long Should a Name Be?
- 名前のフォーマットで情報を伝える／Use Name Formatting to Convey Meaning
- まとめ／Summary
3 誤解されない名前／NAMES THAT CAN’T BE MISCONSTRUED
- 例：Filter()
- 例：Clip(text, length)
- 限界値を含めるときはminとmaxを使う／Prefer min and max for (Inclusive) Limits
- 範囲を指定するときはfirstとlastを使う／Prefer first and last for Inclusive Ranges
- 包含-排他的範囲にはbeginとendを使う／Prefer begin and end for Inclusive-Exclusive Ranges
- ブール値の名前／Naming Booleans
- ユーザーの期待に合わせる／Matching Expectations of Users
- 例：複数の名前を検討する／Evaluating Multiple Name Candidates
- まとめ／Summary
4 美しさ／AESTHETICS
- なぜ美しさは大切なのか／Why Do Aesthetics Matter?
- 一貫性のある簡潔な改行位置／Rearrange Line Breaks to Be Consistent and Compact
- メソッドを使った整列／Use Methods to Clean Up Irregularity
- 縦の列をまっすぐにする／Use Column Alignment When Helpful
- 一貫性と意味のある並び／Pick a Meaningful Order, and Use It Consistently
- 宣言をブロックにまとめる／Organize Declarations into Blocks
- コードを「段落」に分割する／Break Code into “Paragraphs”
- 個人的な好みと一貫性／Personal Style versus Consistency
- まとめ／Summary
5 コメントすべきことを知る／KNOWING WHAT TO COMMENT
- コメントするべきでは「ない」もの／What NOT to Comment
- 自分の考えを記録する／Recording Your Thoughts
- 読み手の立場になって考える／Put Yourself in the Reader’s Shoes
- ライターズブロックを乗り越える／Final Thoughts—Getting Over Writer’s Block
- まとめ／Summary
6 コメントは正確で簡潔に／MAKING COMMENTS PRECISE AND COMPACT
- コメントを簡潔にしておく／Keep Comments Compact
- あいまいな代名詞を避ける／Avoid Ambiguous Pronouns
- 歯切れの悪い文章を磨く／Polish Sloppy Sentences
- 関数の動作を正確に記述する／Describe Function Behavior Precisely
- 入出力のコーナーケースに実例を使う／Use Input-Output Examples That Illustrate Corner Cases
- コードの意図を書く／State the Intent of Your Code
- 「名前付き引数」コメント／“Named Function Parameter” Comments
- 情報密度の高い言葉を使う／Use Information-Dense Words
- まとめ／Summary
Part2：ループとロジックの単純化／SIMPLIFYING LOOPS AND LOGIC
7 制御フローを読みやすくする／MAKING CONTROL FLOW EASY TO READ
- 条件式の引数の並び順／The Order of Arguments in Conditionals
- ifｰelseブロックの並び順／The Order of if-else Blocks
- 三項演算子／ ?: Conditional Expression (a.k.a. “Ternary Operator”)
- do-whileループを避ける／Avoid do-while Loops
- 関数から早く返す／Returning Early from a Function
- 悪名高きGoto／The Infamous goto
- ネストを浅くする／Minimize Nesting
- 実行の流れを追えるかい？／Can You Follow the Flow of Execution?
- まとめ／Summary
8 巨大な式を分割する／BREAKING DOWN GIANT EXPRESSIONS
- 説明変数／Explaining Variables
- 要約変数／Summary Variables
- ド・モルガンの法則を使う／Using De Morgan’s Laws
- 短絡評価の悪用／Abusing Short-Circuit Logic
- 例：複雑なロジックと格闘する／Example: Wrestling with Complicated Logic
- 巨大な文を分解する／Breaking Down Giant Statements
- 式を簡潔にするもう１つのの創造的な方法／Another Creative Way to Simplify Expressions
- まとめ／Summary
9 変数と読みやすさ／VARIABLES AND READABILITY
- 変数を削除する／Eliminating Variables
- 変数のスコープを縮める／Shrink the Scope of Your Variables
- 変数は一度だけ書き込む／Prefer Write-Once Variables
- 最後の例／A Final Example
- まとめ／Summary
Part３：コードの再編成／REORGANIZING YOUR CODE
10 無関係の下位問題を抽出する／EXTRACTING UNRELATED SUBPROBLEMS
- 入門的な例：findClosestLocation（）
- 純粋なユーティリティコード／Pure Utility Code
- その他の汎用コード／Other General-Purpose Code
- 汎用コードをたくさん作る／Create a Lot of General-Purpose Code
- プロジェクトに特化したの機能／Project-Specific Functionality
- 既存のインターフェイスを簡潔にする／Simplifying an Existing Interface
- 必要に応じてインタフェースを整える／Reshaping an Interface to Your Needs
- やりすぎ／Taking Things Too Far
- まとめ／Summary
11 一度に1つのことを／ONE TASK AT A TIME
- タスクは小さくできる／Tasks Can Be Small
- オブジェクトから値を抽出する／Extracting Values from an Object
- もっと大きな例／A Larger Example
- まとめ／Summary
12 コードに思いを込める／TURNING THOUGHTS INTO CODE
- ロジックを明確に説明する／Describing Logic Clearly
- ライブラリを知る／Knowing Your Libraries Helps
- この手法を大きな問題に適用する／Applying This Method to Larger Problems
- まとめ／Summary
13 短いコードを書く／WRITING LESS CODE
- その機能の実装について悩まないで－きっと必要ないから／Don’t Bother Implementing That Feature—You Won’t Need It
- 質問と要件の分解／Question and Break Down Your Requirements
- コードを小さく保つ／Keeping Your Codebase Small
- 身近なライブラリに親しむ／Be Familiar with the Libraries Around You
- 例：コーディングするよりもUnixツールボックスを使用する／Example: Using Unix Tools Instead of Coding
- まとめ／Summary
Part4：選抜テーマ／SELECTED TOPICS
14 テストと読みやすさ／TESTING AND READABILITY
- テストを読みやすく保守しやすいものにする／Make Tests Easy to Read and Maintain
- このテストのどこがダメなの？／What’s Wrong with This Test?
- テストを読みやすくする／Making This Test More Readable
- エラーメッセージを読みやすくする／Making Error Messages Readable
- テストの適切な入力値を選択する／Choosing Good Test Inputs
- テストの機能に名前をつける／Naming Test Functions
- このテストで何がダメだったのか？／What Was Wrong with That Test?
- テストに優しい開発／Test-Friendly Development
- やりすぎ／Going Too Far
- まとめ／Summary
15「分-時カウンタ」を設計・実装する／DESIGNING AND IMPLEMENTING A “MINUTE-HOUR COUNTER”
- クラスのインタフェースを定義する／Defining the Class Interface
- 問題点／The Problem
- 試案1：素朴な解決策／Attempt 1: A Naive Solution
- 試案2：ベルトコンベヤー設計／Attempt 2: Conveyor Belt Design
- 試案3：時間バケツの設計／Attempt 3: A Time-Bucketed Design
- 3つの解決策を比較する／Comparing the Three Solutions
- まとめ／Summary
付録 さらに読む／FURTHER READING
参考文献：
リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック
The Art of Readable Code: Simple and Practical Techniques for Writing Better Code (English Edition)
The Art of Readable Code: Simple and Practical Techniques for Writing Better Code Kindle (English Edition)