2002/02/08
プログラムコメントの話
プログラミングにおける可読性と高速性というのは、基本的には相反する要素です。可読性を高めるためには、どうしても冗長なプログラムを書かなければなりませんし、高速性を高めるためには、どうしても複雑なプログラムを書かなければならないためです。
現在はマシンパワーが高くなり、それほど高速性を必要とはしなくなりましたが、これもケースバイケースで、例えば高速画像処理ロジックなんてのは論理演算の嵐になり、どうしても可読性が低くなるのが常です。これはCPUがどんなに早くなっても変わることはなく、かえってCPUが早くなったのにどうして画像処理が遅いんだ、というお叱りを受けてしまったりします。世の中には未だにCPU速度と処理速度は正比例の関係にあると信じている人達がいるのですよ。では、この相反する要素をなんとかまとめることはできないものでしょうか。そのためにコメントというものがあります。プログラムにどれだけコメントが含まれているか、というのはそのプログラムの可読性の高さを示す指標になるのではないでしょうか。そこで、これはステップ数なのであくまで参考にしかならないということを断った上で私の書いた普通のコード(ロジックよりも可読性を重視してやや冗長)におけるコメント率を求めてみました。ここにステップカウントで2200行のコードがありますが、そのうちのコメントは550行でした。実に4分の1がコメントなのです。では、ロジックの塊のような画像処理系のプログラムのコメント率を見てみましょう。1200行中380行。3分の1程度がコメントになっています。他の開発者の人も見てみました。1300行中250行、3000行中400行・・・。多い人でもおよそ5分の1程度で、私のコメント量が異常に多いということがわかりました。
もちろん、私は自分では無駄なコメントは一切付けていないつもりです。むしろコメントが少ないくらいだと思っています。にも関わらず、実は私の所属している課の中で、最もコメントを多用するプログラマだということが判明しました。これならいつ引継がせることになってもオッケーですね。
前 後
Topへ