リーダブルコードーより良いコードを書く

314viewsシュウジシュウジ

このエントリーをはてなブックマークに追加
リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

読みやすさの基本定理

コードは他の人が最短時間で理解できるように書かなければならない

名前に情報を埋め込む

明確な単語を選ぶ​

汎用的な名前を避ける

抽象的な名前よりも具体的な名前を使う​

接尾辞や接頭辞を使って情報を追加する​

名前の長さを決める​

名前のフォーマットで情報を伝える​

誤解されない名前

限界値を含めるときはminとmaxを使う

範囲を指定するときはfirstとlastを使う

包含/排他的範囲にはbeginとendを使う​

ブール値の名前

ブール値の変数やブール値を返す関数の名前は、trueとfalseの意味を明確にする​

見た目が美しいコード

一貫性のある簡潔な改行位置​

メソッドを使った整列​

重複を排除してコードを簡潔化​

縦の線をまっすぐにする​

意味にある順番に並べる​

「最重要」なものから重要度順に並べる​

アルファベット順に並べる​

宣言をブロックにまとめる​

コードを「段落」に分割する​

コメントするべきでは「ない」こと

コードからすぐにわかることをコメントに書かない​

ひどい名前はコメントをつけずに名前を変える

自分の考えをコメントする

なぜ他のやり方ではなくこうなっているのか​

定数にコメントを付ける(定数にまつわる背景)​

コードの欠陥にコメントをつける

コメントは正確で簡潔に

あいまいな代名詞、文章を避ける

「名前付き引数」コメント​

Connect(/* timeout_ms = */ 10, /* use_encryption = */ false);

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

条件式の引数の並び順

  • 左側:調査対象
  • 右側:比較対象

if/elseブロックの並び順

  • 条件は否定形よりも肯定形を使う​
  • 単純な条件を先に書く​
  • 関心を引く条件や目立つ条件を先に書く

三項演算子は使わない

do/whileループを避ける

ネストを浅くする

早めに返してネストを削除する​
ループ内部のネストを削除する​

関連まとめ

本のまとめカテゴリー


コメントを書く