#リーダブルコード

リーダブルコード

1章

名前は具体的に、意味があり、非汎用的であること
for-loop/whileといった変数の一時利用（都度、値が変わる変数）の場合はtmp, current_orderなどと、意図し- て変数は汎用的なものだと伝えることがある
既存のプログラムで使われている名前と粒度、スコープがズレることのないようにすることは大前提？
- ディレクトリ名はある程度似たり寄ったりになる？
  - e.g.: https://github.com/gothinkster/laravel-realworld-example-app

名前は具体的に、意味があり、非汎用的であること
for-loop/whileといった変数の一時利用（都度、値が変わる変数）の場合はtmp, current_orderなどと、意図し- て変数は汎用的なものだと伝えることがある
既存のプログラムで使われている名前と粒度、スコープがズレることのないようにすることは大前提？
- ディレクトリ名はある程度似たり寄ったりになる？
  - e.g.: https://github.com/gothinkster/laravel-realworld-example-app

改行する、しないはプロジェクトのローカルルールに従う、なければGoogleらが出しているコーディング規約に従う
- 3.2 パッケージ文
- パッケージ文は改行してはならない。文字数制限（4.4節文字数制限は100文字）はパッケージ文には適用されない。
- import文は改行してはならない。文字数制限（4.4節文字数制限は100文字）はimport文には適用されない。
- cf. Google Java Style Guide (非公式和訳)

コードには How
テストコードには What
コミットログには Why
コードコメントには Why not
https://twitter.com/t_wada/status/904916106153828352?s=20
コメントの目的は、書き手の意図を読み手に知らせること
- コメントするべきでは「ない」ことを知る。
- コードを書いているときの自分の考えを記録する。
- 読み手の立場になって何が必要になるかを考える。
- コードからすぐにわかることをコメントに書かない。
- ひどい名前はコメントをつけずに名前を変える
TODO/FIXMEなどが付いたコメントが消えることケースに出会ったことがない
- 「コードからすぐ分かることはコメントしない」と「あまり知られていない書き方の解説をするためにコメントする」塩梅とは？
ファイルの機能に関する要約コメントまでいるか
- ココでいうコメントとは、たとえばpythonのmethodの下にコメントアウトされたメソッドのディスクリプションのことなら必要と思う。ディスクリプションは__docs__で取得可能。

if文における左辺と右辺に書くこと
- 数学でも左辺に変数、右辺に変数に代入されるものを書くからしっくりくる
複数の条件が連なるときに最初に書く条件
- 単純なものは同意。
- 関心を引くものは実装社の主観によるところが多い感がしてなんとも。
- 否定形と肯定系については、条件式に続くケースがシンプルなものを書くようにしている。
  - if-else文の条件が視界に入るように。
ネストの深さの対処法として早くreturnするというのはコーディングレビューで学んだ
- ネストの深さとif-eleeの条件式の順番の決め方はトレードオフにも。