2007.07.31

ソースをきれいに書く理由

最近、色々なプログラマが書いたソースを読む機会がありました。
自戒も含めて、なぜソースがきれいでなければいけないのか、考え直してみました。

ソースをきれいに書く理由を考えてみました。
 ・生産性をあげる。
 ・保守性を高める。
 ・バグを減らす。


では、きれいなソースにするためには、
どのようなことを考えたらよいのでしょう?

生産性をあげるためのきれいなソースとは、、、
 ・共通処理を関数化する。
  →何度も同じ処理を書かなくてすめば、コーディング時間が減るはず。

 ・業務ロジックをまとめて記述する。
  →同じような画面を作成した場合、コーディングしなおす箇所が明確化されて、
   そこだけを作り変えればよいから、時間を短縮できるはず。


保守性を高めるためのきれいなソースとは、、、
 ・コメントを書く。
  →どういう意図でコーディングしているかが書かれていれば、
   仕様変更が入った場合、修正してもよいコードかどうか判断がつきやすくなるはず。

 ・コーディング規約を遵守する。
  →保守の場合、必ずしも最初に作成したプログラマが修正するわけではない。
   誰が作成しても、誰が修正しても、同じようなコードになるようにしておけば、
   修正しやすいはず。

 ・共通処理を関数化する。
  →修正が発生したとしても、修正箇所が少なくてすむはず。

 ・なるべく定数や設定ファイルを利用する。
  →修正が発生したとしても、修正箇所が少なくてすむはず。


バグを減らすためのきれいなソースとは、、、
 ・コメントを書く。
  →コメントが書いてあれば、コードとコメントの違いに気づきやすいはず。

 ・共通処理を関数化する。
  →バグが発生したとしても、修正箇所が少なくてすむはず。

 ・なるべく定数や設定ファイルを利用する。
  →固定文字列の書き間違えを防ぐことができるはず。

 ・業務ロジックをまとめて記述する。
  →業務ロジックを丁寧に見直すことで、重大なバグを防ぐことができるはず。

ソースをきれいにすることは、複数人数で長期に渡る仕事の場合、
特に重要になってきます。一時の時間を惜しむあまり、
自分勝手なソースを書かないよう、心がけましょう。

コメントを投稿

(いままで、ここでコメントしたことがないときは、コメントを表示する前にこのブログのオーナーの承認が必要になることがあります。承認されるまではコメントは表示されません。そのときはしばらく待ってください。)

photo
ooya