More than 3 years have passed since last update.

リーダブルコード要約

Last updated at 2020-04-09Posted at 2018-09-24

###概要
全体の内容をさっと把握したい時などに、お使い下さい。
##リーダブルコードとは
表紙には以下のように記載されています。
***より良いコードを書くためのシンプルで実戦的なテクニック　***

##1章　理解しやすいコード

##2章　名前に情報をつめこむ

##3章　誤解されない名前

filter()
選択するor除外する

Clip(text, length)
文字を切り詰めるor最後から文字を削除する
単位も複数考えられる

bool値の名前
否定的な名前はつけないよう注意
bool disable_ssl = false;

限界値を明確にする
名前の前に「_min」・「_max」を付ける

範囲を指定する
firstとlastを用いる

包含/排他的範囲の場合
beginとendを用いる

bool値の名前
頭にis/has/can/shouldをつける
否定形よりも肯定形で書く
bool use_ssl = true;

##4章　美しさ

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

コメントの目的とは、コードの意図を読み手に理解してもらう事
コメントすべきでは「ない」こと
- コードからすぐに抽出できること
- ひどいコードを補う「補助的コメント」→コメントではなくソースを修正すべき
記録すべき自分の考え
- なぜコードが他のやり方ではなくこうなっているのか
- コードの欠陥をTODO等の気泡を使って示す
- 定数にまつわる背景
読み手の立場になって考える
- 読み手が「えっ？」と思うところを予想してコメントを書く
- ファイルやクラスには「全体像」をコメントする
- コードブロックにコメントを付けて概要をまとめる
ライターズブロックを乗り越える
以下、手順
頭の中にあるコメントをとにかく書き出す
コメントを読んで改善が必要な部分を書き出す
改善する

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

##7章　制御フローを読みやすくする

例1：
if(length > 10)
例2：
if(10 < length)

例1の方が読みやすい
左側：調査対象の式、変化する。右側：比較対象の式、変化しない
if/else文のブロックの並び順
- 肯定形・単純・目立つものを先に処理する
非推奨な要素
- 三項演算子(aa?bb:cc)
- do/whileループ
- goto
ネストを浅くする
- 失敗する場合を出来るだけ早めに関数から返せばよい
- ループ内部のネストを削除する
  - continueを用いる
- 関数の上部で単純な条件を先に処理しておく

##8章　巨大な式を分割する

##9章　変数と読みやすさ

変数を適当に使うとプログラムが理解しにくくなる
- 変数が多いと追跡が難しくなる
- スコープが大きいと、スコープを把握する時間が長くなる
- 頻繁に変更されると現在ではの値を把握するのが難しくなる
対応策
- 邪魔な変数を削除する
  - 中間結果などは不要
- できるだけ小さいスコープとする
  - 変数のことがみえる行数を減らす
- 1度だけ書きこむ変数を使う
  - constやfinalなど

##１０章　無関係の下位問題を抽出する

##１１章　一度に1つの事を

##１2章　コードに思いを込める

##１3章　短いコードを書く

できるだけコードを書かない
- 不必要な機能をプロダクトから削除する。過剰な機能は持たせない
- 最も簡単に問題を解決できるような要求を考える
- 定期的にAPIを読んで、標準ライブラリに慣れておく

##１4章　テストと読みやすさ

テストとはテストコードのこと

他のプログラマが安心してテストの追加や変更ができるようにテストコードを読みやすくする
- できるだけ簡潔に
- 失敗したらわかりやすいエラーメッセージを
- 単純な入力値を使う
- テストに説明的な名前をつけて何をテストしているのかわかりやすくする

##感想