プログラムを書くとき、自分に分かればいいやという気持ちで書くときがあ ります。どうせ自分でメンテナンスをやるのだし、早く完成させるために急い でいるのだから、分かりやすくとか、美しくとか考えられないことがあるでしょ う。私だって、使い捨てのプログラムもいっぱい書いています。そういうとき は、とりあえずの目的を満たすことだけを念頭に置いてプログラムしています。
しかし、そういうプログラムでも、けっこう後で使ったり、さらには機能拡 張したりするものです。こういうとき、作ってから時間がたっていると、自分 で作ったものでも忘れてしまっていて、思いだすのに時間がかかるものです。 自分のプログラムでも、まるで他人のプログラムのように全然分からなくなっ たりするものです。いっぱいドキュメントを作るのもいいのですが、キーとな るコメントだけでも入れておくと非常に助かるものです。コメントやドキュメ ントは量があれば良いというものではありません。
プログラムを移植するとき、ドキュメントを請求したら、1000ページ近いド キュメントを渡されたことがあります。全関数にＡ４一枚の説明がありました。 それを、ご丁寧にも関数のアルファベット順に並べてくれていて、シーケンシャ ルナンバーまで振っていたことがありました。主要な関数について、関数の主 要な機能とか、引数の意味とか、特別に注意しなければならない個所だけを知 りたかったのですが、分厚いファイル２冊も渡されて、見た瞬間に、「これは 無駄だ。裏が白紙だから、裏返してプリント出力にでも使おうか」と思ってし まいました。でも、仕事が終わったら返却しなければならないので、さすが裏 紙として使うことはしませんでした。
でも、この1000ページものドキュメント、どうも私が、「何かドキュメント はありませんか」と言ってから作ったらしいのです。もちろん、今まで受託し て作業をしていた別のソフトハウスが作ったのですが、なかなか大変だったろ うと思います。でも、全く役に立ちませんでした。経理部門が見たら、分厚い ２冊のファイルを見て、立派なドキュメントと思うかも知れませんが、全く役 に立たなかったのです。
