3章誤解されない名前
前章では、名前に情報を詰め込むことについて触れた。本章では、また違った話題に触れたいと思う。それは「誤解される名前に気を付けろ」だ。
名前が「他の意味と間違えられることはないだろうか?」と何度も自問自答する。 |
ここではクリエイティブになって欲しい。積極的に「誤解」を探していくのだ。そうすれば変更が必要なあいまいな名前が見つかるだろう。
本章に登場する例では、誤解する可能性を「ひとりごと」で確認してから、名前を選ぶようにしている。
3.1 例:filter()
データベースの問い合わせ結果を処理するコードを書いているとしよう。
results = Database.all_objects.filter("year <= 2011")
このresults
には何が含まれているだろうか?
- 「year <= 2011」のオブジェクト
- 「year <= 2011」ではないオブジェクト
どちらかよくわからないのは、filter
があいまいな言葉だからだ。これでは「選択する」のか「除外する」のかわからない。filter
という名前は避けるべきだ。簡単に誤解を招いてしまう。
「選択する」のであれば、select()
にしたほうがいい。「除外する」のであれば、 ...
Get リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.