リーダブルコードを読む part9
こんにちはかわです。
アドベントカレンダー２４記事目です。
以下の続きです。
9章 変数と読みやすさ
- 変数が多いと変数を追跡するのが難しくなる。
- 変数のスコープが大きいとスコープを把握する時間が長くなる。
- 変数が頻繁に変更されると現在の値を把握するのが難しくなる。
1 変数を削除する
役に立たない一時変数
以下を満たしている確認する + 複雑な文を分割している + 明確になっている + 複数回使われている
中間結果を削除する
中間結果を保持するより、タスクを早く完了できないかを検討すべき。
制御フロー変数を削除する
doneのようなループのいろんなところにtrueがある変数
これは削除できる
また、 複雑なループ（ネストが何段もあるループ）はコードを
新しい関数に移すなどすべし。
2 変数のスコープを縮める
変数のことが見えるコード行数をできるだけ減らす。
→一度に考えなければいけない変数を減らせるから。
メンバ変数
メンバ変数はクラスの中で「ミニグローバル」になっていると言える。
「ミニグローバル」はできるだけ減らすべき。
staticにしたり、ローカル変数に格下げたりする。
大きなクラスを小さなクラスに分割するのも良い。
c++ のif文のスコープ
if文の条件式のためだけに使われている変数は
条件式の中で定義すればいい
JavaScriptで「プライベート」変数を作る
変数をクロージャで包むのもいい。
JavaScriptのグローバルスコープ
Javascriptはvarをつけないとグローバルスコープになってしまう
気をつける
PythonとJavaScriptのネストしないスコープ
しかしPythonやJavaScriptは関数全体にこぼれ出る。
定義位置を下げる
使う直前に変数宣言をする。
3 変数は一度だけ書き込む
変数を操作する場所が増えると、現在値の判断が難しくなる
以上
リーダブルコードを読む part8
こんにちはかわです。
アドベントカレンダー23記事目です。
以下の続きです。
8章 巨大な式を分割
1 説明変数
if str.split('@')[0] == "kawa"
よりも
username = str.split('@')[0]
if username == "kawa"
のほうが何を書いているか分かりやすい
2 要約変数
user_owns_document = (request.user.id == document.owner.id)
if user_owns_document
#ユーザはこの文章を編集できる
end
if !user_owns_document
#文章は読み取り専用
end
3 ド・モルガンの法則を使う
適用できるか検討する
4 短絡評価の悪用
「頭がいい」コードに気をつける。
あとで他の人が読むときにわかりにくくなる。
ロジックを簡潔に落とし込むことがわかりにくさを生み出すことがある。
5 例：複雑なロジックと格闘する
ロジックが複雑になった場合は別の視点、逆の視点からも考える
単純なロジックにできないかを考える
6 巨大な分を分解する
DRY原則を意識しよう
7 式を簡潔にするもう一つの創造的な方法
メソッド名が似て同じことをしているような時はマクロを定義するのもよし
以上
リーダブルコードを読む part7
こんにちはかわです。
アドベントカレンダー２２記事目
前回の続きです
7章 制御フローを読みやすくする
1 条件の引数の並び順
| 左側 | 右側 |
|---|---|
| 「調査対象の式」。変化する。 | 「比較対象の式」。あまり変化しない。 |
2 if/elseのブロックの並び順
- 条件は否定型より肯定形を使う。
- 単純な条件を先に書く。ifとelseが同じ画面に表示されるので見やすい。
- 関心を引く条件や目立つ条件を先に書く。
この優劣は衝突することがあるため、臨機応変に対応する。
3 三項演算子
行数を短くするよりも、他の人が理解するのにかかる時間を短くする。
基本的にはif/elseを使う。三項演算子は簡潔になるときだけ使用する。
4 do/whileループを避ける
do/whileのループは書き直せることが多い
何のループかをわからせるためにも先に書いたほうがいいかも
5 関数から早く返す
関数から早く返すことはいいことらしい。
returnを１つにしたいということは、
何らかのクリーンアップコードを実行したいから？
関数終了後に呼び出されるコードは各言語あるので調べてみるといい。
6 悪名高きgoto
c言語以外ではgotoは必要ない。
ー＞同じことをする方法が他に存在するから。
基本的には使うな
7 ネストを浅くする
ネストが増える仕組み
機能を追加する際、コードを最も挿入が容易な場所に挿入した結果、
ネストが増えることが多い。
早めに返してネストを削除する
ネスト内部のループを削除する
ループ内で早めに返す場合continueを使う。
ただしcontinueはループを行ったり来たりするためわかりにくい。
気をつけるべき。
8 実行の流れを追えるかい？
プログラムの高レベルの「流れ」についても考えなくてはいけない。
| 構成要素 | 高レベルの流れが不明瞭になる理由 |
|---|---|
| スレッド | どのコードがいつ実行されるかわからない |
| シグナル/割り込みハンドラ | 他のコードが実行される可能性がある |
| 例外 | いろんな関数呼び出しが終了しようとする |
| 関数ポインタと無名関数 | コンパイル時に判別できないので、どのコードが実行されるのかわからない |
| 仮想メソッド | object.virtualMethod()は道のサブクラスのコードを呼び出す可能性がある |
これらの構成要素を利用することで、コードが読みやすくなったり、
冗長性が低くなったりすることがある。
ただコード全体に占める割合を大きくしないことが大切。
