3分リーダブルコード(まとめ)

3分リーダブルコード(まとめ)
こんにちは、きょぱです。今日は省略しすぎたかもしれませんが、
リーダブルコードをまとめて見ました。

 

1章 理解しやすいコード

 

コードは理解しやすくなければならない。
コードは他の人が最短期間で理解できるように書かなければならない。
理解するまでにかかる時間がなにより大切

 

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

 

明確な単語を選択
汎用的な名前をさける(具体的な名前を選ぶ)
名前の長さを決める。
tmpやretvalなどの汎用的すぎる名前は避ける。
スコープが小さければ短い名前でもいい
stringをstr、docmentをdocとしても構わないが、チームメンバーがわかるように共有する。
大文字やアンダースコアでスコープの範囲を区別させる。

 

3章誤解されない名前
書いたコードが、相手に誤解されないようにする必要がある。
length limitなどの抽象的なものを選ぶと相手に伝わりづらい。
限界値を含める場合は mix maxを使用
範囲を指定する場合  first lastを使用

 

4章 美しさ
インデントがととのって適切に改行された美しいコードを目指す。
プログラミングの時間のほとんどはコードを読む時間なので
コードは読みやすく美しく一貫性をもたせる。
ABCのように並べてあるものをBCAなどとするべきではない。
空行を使用すること。

 

5章 コメントをすべき事をする
細くが必要な場合にコメントを記述し、必要のないものにはコメントは控えるべき
読み手が理解しづらいコードを予想して補足コメントを記述する。

 

6章 コメントは正確に簡潔に
関数の動作はできるだけ正確に説明する。
よくわからない引数には、インラインコメントを使用する。
複数のものに、それ、これなどの代名詞を使用しない

 

7章 制御フローを読みやすく
if (length > 10 )採用(読みやすい)
if (10 < length)不採用
do/whileループ・gotoなどのプログラミング要素はあまり使わない方がいい
ネストは浅くすべし

 

8 巨大な式を分割する
巨大な式を一度に理解するのは難しいので分割して読み手がわかりやすくする。
説明変数を用いる。

 

説明変数を導入する利点
  1. 分割できる。
  2. 簡単な名前で式を説明できる。
  3. コードの主要な概念を読み手に認識しやすくなる。

 

9章 変数と読みやすさ
邪魔な変数は削除する。
変数のスコープはできるだけ小さくする。
変数を何度も変更するのではなく、一度だけ書き込む変数を使用する。

 

10章 無関係の下位問題を抽出する
関数やコードブロックを見て「このコードの高レベルの目標は何か?」と自問する。

関数の目的を明確にし、直接的に関係なものは別の関数にしてまとめる。

関数は小さく独立していれば機能追加がしやすく可読性が高い
プロジェクト固有のコードから汎用コードを分離する、しかしやりすぎは注意が必要

 

11章 一度1つのことを

一度に複数のことをするコードは理解しにくい。

コードをできるだけ異なる関数やクラスに分割する。

 

12章 コードに思いを込める
コードを簡単に簡潔にすることは非常に強力
コードを声にだして説明することで、簡潔なコードを思い浮かぶ技法がある。

 

13章 短いコードを書く
最も読みやすいコードは何も書かれていないコード
不要な機能はプロダクトから削除する。
最も簡単に解決問題を解決できるような要求を考える。

 

14章 テストと読みやすさ
テストと読みやすさ
テストには最もキレイで単純な値を選ぶ。
テストが失敗したらバグの発見や修正がしやすいようなエラーメッセージを表示する。
テストを読みやすく、保守しやすく作る。

 

15章 実践(省略)
以上です!!