今週のアイロベックス

可読性の良いプログラムを書く

  • 2010年8月9日
  • 松本
  • matsumoto

先日、「保守を考えたプログラム」という題で、中村が記事を書きましたが、
今回は、私が普段プログラムを組む際に、可読性を良くするために、
気をつけていることについてお話したいと思います。

（１）条件が多い分岐は、ネストになってしまっても、分ける。

A = B かつ、C <> D かつ、E = F または ...というように、
分岐条件が多くある場合があります。

大概、実際のソースでは、「A = B」の3文字で済むことなど無いので、
条件が多くなればなるほど、エディタの横幅から溢れていきますし、
改行を入れても読みづらくなりがちです。

また、仕様変更があった場合にも、
どこに条件を追加するのが妥当なのか判断するのに時間もかかります。

そのため、私は、ネストすることになっても、if文を分けて書くようにしています。

最初は権限区分の条件のif文、その後に日付等データの条件判定のif文など、
なるべく意味によってグループ分けします。

プログラマーとして、なるべくひとつの文に収まることを追求することも大事ですが、
誰でも修正しやすく、誰にでもわかるコードを書くことが、
システム開発においては重要だと思います。


（２）コメントは要所要所にしっかり残す。

よく、コメントを残さなくてもいいようなソースコードを書け、
というようなことが本などに載っていると思いますが、
私は、仕様の重要な点や、なぜこのような作り方をする必要があるのか、
コメントをなるべく詳しく書くようにしています。

プログラム作成にあたり、なぜこのような作りになった（作りをした）のか等、
仕様書に記載しきれないことは、作ったときに書いておくと、
メンテナンスすることになった場合に、非常に役に立ちます。
（書いておかないと、後で思い出せない場合も多々有ると思います。）

また、仕様についてコメントしておくことで、
上司や先輩がソースチェックをした際に、どういう意図でそのソースを書いたのかがわかり、
仕様が間違っていればすぐにわかりますし、
コメントとソースの内容が違っていれば、バグだということもすぐにわかります。

ちなみに、私がコメントをつける際に注意しているのは次の2点です。

1．1つのコメントは、長くなっても2行までにする。

2．他の処理からコピーしてきたソース中のコメントが残ってしまい、
　 内容が食い違ったままにならないようにする。


（３）インデントはしっかりつける。

当たり前のことですが、インデントをしっかりつけておけば見やすいです。
特に、他の人が作ったプログラムを読む時には、インデントが揃っていないと、読むのが大変です。
インデントくらい、と思わずにしっかり揃えましょう。

私たちの作っているプログラムは、一旦作成、納品したらそれで終わりではありません。
お客様のご要望にお応えしやすいよう、
修正しやすいプログラム、可読性の良いソースコードの実装を心がけたいですね。

最新の記事

バックナンバー

株式会社アイロベックス
TEL : 03-6892-2526
システム開発や、その他アイロベックスへのお問い合わせこちらから
ページのトップ