リーダブルコードで改めて今すぐ気をつけれること
一回は読んだことがあったのだが、新人として業務をこなしていく中で、改めて読むように言われたので二回目読んだときになるほど、と思ったことをメモ。
命名規則
- 数値の変数名には単位の情報を含める
delay_secs
size_mb
max_kbps
degrees_cw
- 限界値
min max
- 範囲
first last
- 包含・排他的範囲
begin end
- bool値
is,has,can,shouldを接頭辞につけることが多い
コメント
- 質問されそうなところを書く
- ハマりそうな罠をかいておく
- コードからすぐに抽出できることは書かない(新情報を書くようにする)
制御フロー
- 条件式の引数の並び方
「調査対象」の式。変化する [条件式] 「比較対象」の式。変化しない
if(調査対象 < 比較対象)
- ネストを浅くする
ネストを浅くするには、早めに失敗ケースをかいて関数から返す。
- 複雑なロジックを書かないためにド・モルガンの法則などを利用する。
そうじゃない部分を実装することで満たせないか?考え方を変えてみる
コードの再構成
- 関数の中でも同じ種類のタスクはまとめて処置をするようにする。ちらばってると重複もあるし、読みづらい。(countupがあれば、すべての種類のcountupはまとめて書く)
delay_secs
size_mb
max_kbps
degrees_cw
min max
first last
begin end
- 質問されそうなところを書く
- ハマりそうな罠をかいておく
- コードからすぐに抽出できることは書かない(新情報を書くようにする)
制御フロー
- 条件式の引数の並び方
「調査対象」の式。変化する [条件式] 「比較対象」の式。変化しない
if(調査対象 < 比較対象)
- ネストを浅くする
ネストを浅くするには、早めに失敗ケースをかいて関数から返す。
- 複雑なロジックを書かないためにド・モルガンの法則などを利用する。
そうじゃない部分を実装することで満たせないか?考え方を変えてみる
コードの再構成
- 関数の中でも同じ種類のタスクはまとめて処置をするようにする。ちらばってると重複もあるし、読みづらい。(countupがあれば、すべての種類のcountupはまとめて書く)
「調査対象」の式。変化する [条件式] 「比較対象」の式。変化しない
if(調査対象 < 比較対象)
- 関数の中でも同じ種類のタスクはまとめて処置をするようにする。ちらばってると重複もあるし、読みづらい。(countupがあれば、すべての種類のcountupはまとめて書く)
他にもいろいろあるだろうけど、知識として抜けていた部分をメモ。
あとは知っていてもできていない、適用できていない部分が多い気がする。
Author And Source
この問題について(リーダブルコードで改めて今すぐ気をつけれること), 我々は、より多くの情報をここで見つけました https://qiita.com/chiiia12/items/82aecb373e1dcd090fc7著者帰属:元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .