リーダルコードの感想(明確な単語を選ぶ)
メソッド名で何をしようとしているのか、曖昧なままつけていることが多かった。
自分一人でやっている場合は、結局自分しか分からないはずなのに、振り返ってみるとわからない・・・なんてことがある。
可読性の高いコードはどういうものかということを身に付けるために
を購入してみた。
現在は2章の途中だが、少しずつ感想を書いていきたい。
鍵となる考えとして、下記のことがある
- 明確な単語を選ぶ
- 汎用的な名前を避ける(あるいは、使う状況を選ぶ)
- 抽象的な名前よりも具体的な名前を使う
- 接尾辞や接頭辞を使って情報を追加する
- 名前の長さを決める
- 名前のフォーマットで情報を伝える
この中で実践的で効率がいいのは、明確な単語を選ぶ
ことだと思う。
何をしようとするのかを伝えるには、役割を明確にするのがいい。
def GetPage(url) ...
これだけでは、どこから取ってくるのかが想像つかない。
ローカル・インターネット・データベース?
インターネットから取ってくる場合は
def FetchPage(url) def DownLoadPage(url)
と、何をするのかきちんと伝える方が役割が分かる。
自分だけしか分からなくても、どこから何をしようとしているのかを伝えるのが大切です。
5W1Hの考えですね。
Who(誰が) What(何を) When(いつ) Where(どこで) Why(なぜ)したのか? である。しかし日本においては、「5W」にさらに下記の「1H」を含む「5W1H」であるべきであるとされる。 How(どのように)
B型の自分は、相手がわかっている前提で話をしてしまうので、これは気をつけないと・・・