人が書いたプログラムは読みたくない


私がシステムの開発をしていたとき、上司や同僚と手分けしてプログラムを書く事はよくありました。出来上がったプログラムを合わせてテストしたらうまく動かず、私がそのソースを合わせてデバッグすることになったのです。これはよくあることです。しかし、人の書いたプログラムというものは、ちんぷんかんぷんのコードであることがたまにあり、難航しました。変数名やプロシジャ名、開発者が思い思いにつけていたり、インデントを利用しないで全部1カラム目に書いていたり、1行に2つ以上の文が続けて書いてあったり。

一人で全体を把握して、全部最初から最後まで作るなら、こんなこと気にしなくていいのでしょうが、みんなで手分けして作るときは、そのメンバの誰が見てもすぐわかるプログラムを書く必要があります。どうすればいいか、箇条書きにしてみましょう。

(1) 変数名などの名前は、規則性を持たせる。
(2) インデントは必ずつける。1行に1文のみ。
(3) 規則をやむを得ず破るときは、コメント文をつける。
(4) プログラム仕様書を書く。

学校などでプログラム開発を学んだ人は、当たり前のことのように思うかもしれませんが、私のように学校で学んだことがない人は、知らないものです。一緒に開発する人数が多い場合ほど、重要になってきます。まして、プログラム開発を複数の会社で分業する場合など、ますますわけがわからなくなります。変数名は大文字と小文字でメリハリをつける場合もありますね。あれはわかりやすいです。一文字だけの変数名は、複数の関数で重複して使いがちですので、関数内だけで使用を完結するようにしましょう。プログラム仕様書は簡単ですから、書く癖をつけましょう。プログラム仕様書については、あとで詳しく書きます。

プログラム仕様書は書かない、という会社さんと仕事したことがありますが、「2度と一緒にやりたくない」と思いましたね。いちいち、これはなんだ、説明してくれ、と聞くのは、骨が折れました(苦笑)

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です