コラム：綺麗なコードを書くには

こんにちは。
てりーです。

今日は、綺麗なコードを書くには、というお題で説明します。動くコードがそこそこかけるようになったら、次のステップとして読んでほしいです。

なぜ、コードは綺麗でないといけないのか

コードは基本的にgitなどのバージョン管理で管理され、複数の人が読みます。自分だけがわかればいいという風に記述してしまうと、他人が読むと非常に難解なコードになります。少しでもわかりやすいように記述する必要があります。

また、自分が書いたコードでも、3ヶ月、半年たって見直すと他人が書いたコードではないか、というくらいさっぱりわからなくなっています。わかりやすいコードを書くことはとても重要です。

リーダブルコード

コードの綺麗さ、というテーマだとほぼ必ず紹介されている本です。いい本です。ただ、ある程度コードを書くようになってからでないと価値がわかりにくい本ではあるので、しばらくたってからで読むので良いです。

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

詳しいところはリーダブルコードに譲るとして、ここから、気をつけた方が良い基本的なポイントに簡単に説明します。

意味のある変数名をつける

（注：ES5を前提として、varを用います。）

var c=0;

cだけだと、何のための変数なのかさっぱりわかりません。

var counter = 0;

counterとあれば、カウントするための変数なのだなとわかります。

同じコードを複数回記述しない

一つのソースコード内に同じコードを何度も記述しないのが大事です。
共通部分は関数として独立させて、一つにまとめます。

不要なコードはコメントアウトで処理しない

不要なコードでも、あとでまた復帰させるかもしれない、という理由でついついコメントアウトしがちです。しかし、そもそもgitがあればコメントアウトで残しておく必要がありません。

ざっくり消してしまいましょう。

マジックナンバーは使わない

プログラムにおけるマジックナンバーとは、何らかの識別子もしくは定数として用いられる、プログラムのソースコード中に書かれた具体的な数値のことを言います。

（注：ES5を前提として、varを用います。）

var expireTime = 60*60*24;

例えばこれは1日を秒数でカウントした物をexpireTimeという変数に入れています。1日は86400秒なので、86400がexpireTimeに入ります。

でも、上記の一行だけを見てもピンとこないと思います。

var secOfDay =  60*60*24;
varr expireTime = secOfDay;

こうすればわかりやすいと思います。

それでは、また。