品質のよいプログラムを作る－コメント
ソフトを作る時に欠かせないプログラム。そのプログラムの品質を上げる方法について「コメント」に視点をおいて私なりに下記にちょっと書いてみました。
ある冊子を読んでいたら下記のようなことが書かれていました。
日本製品の品質の良さは、丁寧なものづくりにあるといえるのではないでしょうか。例えば、日本では昔から目に見えない部分をも大切にしてきました。
昔から日本人は手先が器用でその器用さから品質のよい製品を作り続けたといわれます。上記のようなものづくりに対するこだわりもその理由の1つかもしれません。
以前、パソコンのAppleの創始者であるスティーブ・ジョブズは、パソコンを開発する時にパソコンの背面までこだわって開発したと以前テレビで見たことがあります。このこだわりが今のAppleを築いた1つの要因かもしれません。
これらのことから私個人が思ったことは、プログラムを開発する時にもこの様なこだわりは重要なことなのかもしれないということです。プログラム開発のこだわりを考えると、変数名やロジックなど開発者それぞれにいろいろなこだわりはあるでしょう。その中の1つでもあるコメントは人によってまちまちだったりします。ある人は、
「コメントは不要なものだ。プログラムをちょっと見ればわかる書き方をすればいい」
という人もいれば、プログラムの長さよりもコメントの方が長いぐらいに細かくコメントを書く人もいます。どちらも間違いではないでしょう。けど、私はどちらかというと後者の方が後からプログラムを見る人にとっては親切かなと思うので、コメントを書くようにしています。もちろん、プログラムその物も見るだけでわかりやすいようには努力をしています。けど、このコメントを書くという作業はなかなか大変な作業だったりします。
「日本語で好きなように書けるんだから、別に大変じゃないのでは？」
と思う人もいるかもしれませんが、開発時はそのプログラムをどのようにして動かすかに集中するため、私の場合は説明(コメント)を書くという作業は結構邪魔な作業だったりするのです。本当はその開発中に随時、書けばいいのが、後々になって結局は説明を書くことができなかったりするのです。
PHPのライブラリであるPEARのプログラムを覗いてみると事細かにプログラムのコメントが書かれているところがあります。ここまでコメントを書けるようになると私としては満足なのですが、なかなかここまで書くことは難しかったりします。
プログラムは「物」ではないですが、私は「形のない物」の1つだと思っています。その物の品質を上げることによってお客様などに喜んでもらい、満足してもらうことが大事なこと。お客様にとってはプログラムのコメントがどのようになっているかは関係ないことですが、その様に見えないところをキチンとすることによって本当に良い物が生まれるのかもしれません。
下記にプログラムのコメントについて書かれているページがいくつかありましたので、参考のためにリンクを貼っておきます。(というか、自分の備忘録だったりして(^^ゞ)
コメント – いいプログラムを書こう
Geekなぺーじ : C言語入門：コメントの書き方
コメント論｜悪態のプログラマ
よくないプログラムコメントの書き方について – suVeneのアレ
Code Complete第2版〈上〉―完全なプログラミングを目指して著者／訳者：スティーブ マコネル
出版社：日経BPソフトプレス( 2005-03 )
定価：￥ 6,405
Amazon価格：￥ 6,405
単行本 ( 628 ページ )
ISBN-10 : 489100455X
ISBN-13 : 9784891004552
Code Complete第2版〈下〉―完全なプログラミングを目指して著者／訳者：スティーブ マコネル
出版社：日経BPソフトプレス( 2005-03 )
定価：￥ 6,405
Amazon価格：￥ 6,405
単行本 ( 545 ページ )
ISBN-10 : 4891004568
ISBN-13 : 9784891004569
TrackBack URL