リーダブルコードを要約した

リーダブルコードを読む目的

• リーダブルコードの表紙には「より良いコードを書くためのシンプルで実践的なテクニック」と書かれている。
• チームの開発力を高めるためにはコードの可読性を上げることが、開発時間の短縮と保守性の向上に繋がる。
• 以下にリーダブルコードの要点をまとめた。

関数名や変数名を読みやすくする

tmpやfooといった名前を避ける

• tmpやfooといった名前は情報がないので可読性が下がる。
• 関数・変数の目的や値に適した名前を付ける必要がある。

具体的な名前を付ける

• getのような動詞は関数・変数名に使いやすい単語である反面、名前の意味が曖昧になることがある。
  • より具体的な動作を表す単語を使用することで可読性が上がることがある。
• 数字の変数名には単位を追加したり、変数・関数の特徴を示す情報を追加する。

誤解されない名前を付ける

• 値の限界値を示す変数にはmaxやminを使用した変数名を付ける。
• 範囲の指定にはfirstとlastを使用した変数名を付ける。

コメントするべきこと

• コードからすぐ分かることをコメントしない。
• コードの意図や考えをコメントとして記録する。
• TODO:やFIXME:でコードの課題を記録する。
• 定数を定義したときはその数字を設定した理由をコメントで記述する。
• ファイルやクラスには機能を要約したものをコメントで記述する。

ロジックの可読性を上げる

条件式の使い方

• 引数を比較するときは変化させる値を左に、より安定した値を右に配置する。
• if/else文のブロックを適切な順番で並べることで可読性が上がる。
  • 条件は否定形をなるべく避ける。
  • 単純な条件や目立つ条件を先に書く。(この場合否定形を使う場合もある。)
  • 三項演算子(条件 ? a : b)は煩雑なコードになる場合には使用しない。
• do/while文を避ける。
• ネストを浅くする。

変数・関数を使用する/削除する

• 説明変数を使用して式を分割する。
  • 一方でコードの可読性を上げない変数の濫用は避ける・削除する。
• 変数のスコープを縮める。(グローバル変数を避ける。)
• 無関係の下位問題を別の関数として抽出する。