本書の第1部「表面上の改善」にある3章のサマリーをまとめる。
(一時的にコード例は省略しています)
3つの原則
* 読み手が慣れているパターンと一貫性のあるレイアウトを使う
* 似ているコードは似ているように見せる
* 関連するコードをまとめてブロックにする
4.1 なぜ美しさが大切なのか?
見た目が美しいコードの方が使いやすい。
さっと流し読みができれば、誰にとっても使いやすいコードと言える。
4.2 一貫性のある簡潔な改行位置
コードの見た目を一貫性のあるものにするには適切な改行を入れるように。コメントも整列させよう。
4.3 メソッドを使った整列
ヘルパーメソッドを使うことでコードを改善することができる。
また、コードの見た目をよくすれば、表面上の改善だけでなく、コードの構造も改善できる。
4.4 縦の線をまっすぐにする
列を整列させれば、コードが読みやすくなることがある。ミスも見つけやすくなる上、楽に流し読みができる。
整列すべきなのか?
4.5 一貫性と意味のある並び
コードの並びがコードの正しさに影響を及ぼすことは少ないが、そうであればランダムに並べずに意味のある順番に並べるといい。
例えば、
* 対応するHTMLフォームのフィールドと同じ並び順にする
* 最重要なものから重要度順に並べる
* アルファベット順に並べる
4.6 宣言をブロックにまとめる
人間の脳はグループや階層を1つの単位として考える。
コードの概要を素早く把握してもらうために、「単位」を作る。
例えば、全てのメソッドを1つの大きなブロックにまとめるのではなく、論理的なグループに分けてあげる。
コード行は増えるとしても、読みやすくなる。
グループに分けたことで、最初にグループを把握して、後から必要になったときに詳細を読めるようになる。
4.7 コードを「段落」に分割する
文章は複数の段落に分割されているが、それは
* 似ている考えをグループにまとめて、他の考えと分けるため
* 視覚的な踏み石を提供できるから、ページの中で自分の場所を見失わない
* 段落単位で移動できるようになる
段落ごとに要約コメントを追加すれば、コードにざっと目を通せるようになる。
4.8 個人的な好みと一貫性
一貫性のあるスタイルは「正しい」スタイルよりも大切
4.9 まとめ
一貫性と意味のあるやり方でコードを整形
- 複数のコードブロックで同じようなことをしていたら、シルエットも同じようなものにする
- コードの列を整列すれば、概要が把握しやすくなる
- ある場所でA, B, Cのように並んでいたものを他の場所でB, C, Aのように並べてはいけない。意味のある順番を選んで、常にその順番を守る
- 空行を使って大きなブロックを論理的な段落に分ける