📌

リーダブルコード第3・4章を読んでみた

2024/04/17に公開

ご挨拶

前回の続きでリーダブルコードの第3・4章を読んでみたのでアウトプットしていきます!

リーダブルコードについて

エンジニアの必読書と書かれていたため、最初の一冊として読んでみることにしました。
この本の目標は「理解しやすいコードを書くこと」です!
気になる方は是非読んでみてください!
https://amzn.to/3VWXZbp
https://a.r10.to/hPU6pe

この記事の対象者

  • 名前の付け方に迷う人
  • 名前が何を示しているのか勘違いされる人
  • 理解しやすいコーディングを目指す人

第3章「誤解されない名前」

  • 限界値を含めるときはlimitではなくminとminとmaxを使う
  • 範囲を指定するときはstartやstopではなくfirstとlastを使う
  • 包含/排他的範囲にはbeginとendを使う
  • ブール値の名前は肯定文で「Is.has・can・should」を接頭辞につける

それぞれ詳しく見ていきましょう。

限界値を含めるときはlimitではなくminとminとmaxを使う

例えば、以下のような変数があったとする。

CART_TOO_BIG_LIMIT = 10

この場合、「未満(境界値を含まない)」なのか「以下(境界値を含む)」なのかわからない。
そこで

MAX_CART_TOO_BIG = 10

とすれば明確になる。

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

startは明確な名前だがstopの場合、stopが包含の意味合いがあるかどうか曖昧である。
そこで、包含関係がある場合には[start,stop]ではなく[first,last]とすべきである。
排他的な意味合いがある場合には[begin,end]とすべきである。

第3章まとめ

  • 限界値を含めるときはlimitではなくminとminとmaxを使う
  • 範囲を指定するときはstartやstopではなくfirstとlastを使う
  • 包含/排他的範囲にはbeginとendを使う
  • ブール値の名前は肯定文で「Is.has・can・should」を接頭辞につける

第4章「美しさ」

この章では美しさについて語られている。
どうやらインターネットで検索してみると自動でしてくれるツールが多いようなので割愛する。

第4章まとめ

  • 複数のコードブロックで同じようなことをしているものはシルエットも同じにする
  • メソッドを使うことで整形する
  • 縦のラインをまっすぐに入れるようにする
  • ある場所でABCという風に並んでいるなら他の場所でBCAのように並べてはならない
  • 空行を使って大きなブロックを論理的な「段落」に分ける

Discussion