コードリーディングにおいて聖典となっているリーダブルコードについて読んでいこうかと。
ただ読んでいくだけではつまらないので、自分なりの考え方も書いていきます。
Contents
優れたコードの定義
まずは優れたコードの定義から。
リーダブルコードでは「読みやすい、理解しやすいコード」って書いてあります。
目的としては当然、保守しやすくするためで「他人が読んでもわかる状態」にすることが大切。ちなみにこの場合の「他人」で最もあり得るのは将来の自分でしょう・・・
少し時間がたつとコードって基本わけがわからなくなるので・・・これには完全に同意。
読みやすいにもいろいろあるかとは思いますが、下記のようなことが大事。
短いコード
自分の場合、一番注意しているのはこれですね。基本的にプログラムは長ければ長いほど理解しにくくなります。なるべく処理ごとに分割して短いコードを目指しましょう。目安としては20~30行以内になるようにしています。
50行を超えるような場合、特別な理由がなければ別メソッドに切り出したほうがよいでしょう。長くしていいのはコントローラー的なメソッドか並列的な処理(switch)が続いた場合のみにしてます。
処理が複雑でない
短くても無理やり1行にしていたりとか、かえってわかりにくくなっているコードは少なくありません。
短くするのは理解しやすくするための手段なので長く書いたほうが理解やすい場合は当然長く書いたほうがよいです。
次回以降もっと具体的に書いていきます。
ちなみにコードに関して参考になった記事を下記に。