リーダブルコードを読んだ(1部)

リーダブルコードを読んだので、メモ用に投稿します。

1章 理解しやすいコード

「優れた」コードって何?

コードは他の人が最短時間で理解できるように書かなければいけない。
自分しか読むことがなくても、6ヶ月後の自分にとっては見覚えのないコードになっているかもしれない。

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

  • 明確な単語を使うこと
  • tmpやretvalのなどの汎用的な名前を避ける
  • 単位や属性などを示す情報を追加する

3章 誤解されない名前

  • 曖昧な英単語を使わないこと

4章 美しさ

  • 一貫性あるインデント
  • メソッドを使った整列
  • 宣言をブロックにまとめる
  • コードを段落に分割する
  • 個人的な好みと一貫性

5章 コメントすべきことを知る

コメントがあるということはその分だけ読む時間が長くなることになる。また、画面も占領してしまうので、それだけ価値を持たせるべきである。

6章 コメントは正確で簡潔に

  • コメントは領域に対する情報の比率が高くなければいけない
  • コードの意図は、詳細レベルではなく、高レベルで記述する
  • 多くの意味が詰め込まれた言葉や表現を使って、コメントを簡潔に保つ
Sign up for free and join this conversation.
Sign Up
If you already have a Qiita account log in.