前回、良いコードかどうかは相手に内容を伝えようとしているかどうかの違いといったことを書きました。
今回は実際のコードで実例を交えながら、説明したいと思います。
前回、カレーの例をお見せしましたが、そのときのA)をソースコード風に表現するとこんな感じになります
まず、pだのoだのが何を指し示しているかわかりません。
お見せした例が極端に見えるかもしれないですが、意外とめんどくさがられて省略された名前が放置されることはよくあるので、何が何を示すのか名前付けることは常に意識したほうが良いです。
今回はこんな感じになると思います
でも、まだわかりにくいところは残っています。注目すべきは3回出てくるsleepです。
大抵の場合、このように同じような処理を何回もやる場合は、メソッドにくくりだして、それに適切な名前をつけるとわかりやすいコードになります。ここでは、次のようにします。
(よく、くくりだすことが強調されますが、それ以上に名前が重要です。後述します)
ここでのポイントは、メソッドを分けた上で、さらにcookとboilの2つがあることです。
同じ処理構造をしている=まとめて一つのメソッド/関数にしてしまう。と、いったことをやりがちですが、個人的には目的が同じでなければ、このように、似ていても分けて、それぞれに意味のある名前をつけるべきだと思います。もし統一するのであれば、より抽象的な、「火にかける」のような名前にしますが、肉と玉ねぎとカレーの具を火にかけるは同じ作業なのか考える必要があります。
(炒めることと煮ることは違う作業ですよね)
これでだいたい終わりです(数字がマジックナンバーなのはまた別の日にでも)。最後にメソッドの名前を変えるのを忘れないようにしましょう。
しつこいですが、メソッドに、その中身がやっていることをなるべく正確に示す名前をつけることは重要です。
今回はカレーを作ったのでこんな感じでしょうか。
それでは、良いコード日和を
今回は実際のコードで実例を交えながら、説明したいと思います。
前回、カレーの例をお見せしましたが、そのときのA)をソースコード風に表現するとこんな感じになります
String menu() { String p = "p"; String o = "o"; String m = "m"; Thread.sleep(5000); m += "c"; Thread.sleep(1000); o += "c"; String c = p + o + m; Thread.sleep(10000); c += "bl"; return c; }問題は、いろいろ有ります。順番に前回のB)のレシピのようにしていってみましょう。
まず、pだのoだのが何を指し示しているかわかりません。
お見せした例が極端に見えるかもしれないですが、意外とめんどくさがられて省略された名前が放置されることはよくあるので、何が何を示すのか名前付けることは常に意識したほうが良いです。
今回はこんな感じになると思います
String menu() { String potato = "potato"; String onion = "onion"; String meat = "meat";これで、p、o、mがそれぞれ何を表しているかわかりやすくなりました。
(以下略) }
でも、まだわかりにくいところは残っています。注目すべきは3回出てくるsleepです。
大抵の場合、このように同じような処理を何回もやる場合は、メソッドにくくりだして、それに適切な名前をつけるとわかりやすいコードになります。ここでは、次のようにします。
(よく、くくりだすことが強調されますが、それ以上に名前が重要です。後述します)
String menu() { String potato = "potato"; String onion = "onion"; String meat = "meat"; meat = cook(meat, 5000); onion = cook(onion, 1000); curry = boil(potato + onion + meat, 10000); return curry; } String cook(String ingredient, long timeMillis) { Thread.sleep(timeMillis); return ingredient + "Cooked"; } String boil(String ingredient, long timeMillis) { Thread.sleep(timeMillis); return ingredient + "Boiled"; }どうでしょうか。だいぶ元のコードが改善されて、パッと見ただけでも何をしているかわかるようになっていないでしょうか?
ここでのポイントは、メソッドを分けた上で、さらにcookとboilの2つがあることです。
同じ処理構造をしている=まとめて一つのメソッド/関数にしてしまう。と、いったことをやりがちですが、個人的には目的が同じでなければ、このように、似ていても分けて、それぞれに意味のある名前をつけるべきだと思います。もし統一するのであれば、より抽象的な、「火にかける」のような名前にしますが、肉と玉ねぎとカレーの具を火にかけるは同じ作業なのか考える必要があります。
(炒めることと煮ることは違う作業ですよね)
これでだいたい終わりです(数字がマジックナンバーなのはまた別の日にでも)。最後にメソッドの名前を変えるのを忘れないようにしましょう。
しつこいですが、メソッドに、その中身がやっていることをなるべく正確に示す名前をつけることは重要です。
今回はカレーを作ったのでこんな感じでしょうか。
String prepareCurry() { String potato = "potato"; String onion = "onion"; String meat = "meat"; meat = cook(meat, 5000); onion = cook(onion, 1000); curry = boil(potato + onion + meat, 10000); return curry; } String cook(String ingredient, long timeMillis) { Thread.sleep(timeMillis); return ingredient + "Cooked"; } String boil(String ingredient, long timeMillis) { Thread.sleep(timeMillis); return ingredient + "Boiled"; }いかがでしたでしょうか?意外と簡単な印象を受けていただけてたら嬉しいです。 もちろん、これ以外にも様々なことを気をつける必要は有りますが、まずはそれぞれのメソッドの目的を明確化して、きちんと名前付けするのを意識するだけでもだいぶ綺麗なコードが書けるようになるはずです。
それでは、良いコード日和を
コメント