shiki0331’s blog

Web Developer. TypeScript / React.js を中心に学んでいます。 ブログ内容で間違っている箇所などありましたら、ご指摘していただけると助かります。

20分チャレンジ リーダブルコード 第三章 「誤解されない名前」

20分で本を要約していきます!



変数の名前には誤解されない名前を付けよう。


あいまいな名前を付けてしまうと、コードの理解を複雑にしてしまう。



filter・length・limitのような名前だとコードの意味がわかりにくい。


例えばCART_TOO_BIG_LIMITの名前では未満か以下なのかわからない。


限界値を含めるときは名前の前にmaxやminを付けて明確にしよう。


MAX_ITEMS_IN_CARTなら名前から以下であると予測できるだろう。


次は範囲を指定するときだ。


start・stopでも表せるが、first・lastの方が理解しやすいだろう。


lastであれば最後まで含まれると予測できるからだ。


他にもbegin・endと表してもいいだろう。



ブール値の名前の付け方だ。

ブール値は論理値。つまりtrue・falseのこと。


read_password = trueでは、

パスワードをこれから読み取るのか?

パスワードをすでに読み取ってるのか、わかりにくい。


代わりに、need_password やuser_is_authenticatedと名前を付けるべきた。


そうすれば誤解されないだろう。



名前を決めるときには複数の名前を検討するのが大事だ。


名前を付ける時には理解しやすさを求めるのも大事だが、誤解されない名前といった視点を持つとより良いだろう。



以上です!



僕は英語が苦手なので、名前を付けるときにパッと単語が出てこないですね。


なので、類似語を調べたりすると良い名前が

付けれる気がします。


リーダブルコードにも書いてありましたね!



名前を付けたときに、本当にその名前で良いか一度立ち止まって考える癖を付けるべきですね。



本を要約するときにはコピペになりすぎず、内容をできる限り短くできるように心がけているつもりです。


あとは自分の言葉で置き換えることですね。


けど、これがなかなか難しい、、

結構コピペになってしまってるかな、、


次回はもっと意識します!!


最後まで読んでいただき、ありがとうございました。