読書会でまとめたものになります

04章『美しさ』

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

 

担当:やし