謎言語使いの徒然

適当に気になった技術や言語を流すブログ。

プログラムを読みやすくするための個人的Tips

個人的に綺麗なコードを書くために心がけているもの。

数が多いので、効果があると個人的に思っているものだけ集めてる。

なぜ読みやすく書くのか

読みやすいことに興味がない人のコードで、本当に汚ければ遠慮なくけなすし、そのコードを保守したいとも触りたいとも、 仕事でなければ関わりたくすら無いことを明記しておく。

一度だけ書いて、二度と保守もメンテも必要無い書捨てのスクリプトなら、とやかくは言わない。
しかし、多くのプロダクトがそうであるように、アプリケーションはメンテナンスする。
それはバグ改修だったり、性能向上だったり、機能追加だったりスルだろう。

その時、作りを理解するのは何か?
Excel 方眼紙に書いた行単位では意味が読み取れない日本語文章か?

違うだろ?

結局のところ読んで、理解して、手を入れるのは コード なんだ。
加えて実際の修正量とコードを読む量どっち多い?

聞くまでもない。

間違いなく読む量だ

なら、読みやすいコードこそ把握しやすく、バグも埋め込みにくく、容易に修正できるものだと言えるのでは?

だから 綺麗に書かれたコードが正義なんだ と考える。

他にも、コードは仕様上でも重要なドキュメントだ。

読みづらいドキュメントを誰が訂正するんだ?誰も触りたくなんて無い。
だから学ぶんだ。

美しく書くには

コードの美醜と言うものを知らなければできない…と経験で上がってきた人は居ると思う。
それも方法の一部であることは事実である。

美しいとは経験だ。当然ながら無垢な3歳時が名画を見て「すごい」とは思っても「美しい」とは思わない。
それは経験のなせることだからだ。

そうした意味では OSS のソース、それも多くのマージがあったものが良いかもしれない。
(複数人がメンテする必要があるということは、それ相応に読めるように出来ているだろうと予測はできる)

だが、もう一つ学ぶ方法がある。

それは「 原則を学ぶ 」だ。

原則自体は、図書「プリンシプル オブ プログラミング」を見ていただくとして、特に効果のあった思考を順におっていこうと思います。

本にもなっている。気になる人はこのエントリの下の方参照。

普段気にしてるもの一覧

項目が多いので、別のエントリで色々書こうと思う。

参考