コメント書き@doxygen

piy2010-03-04


月曜以来ほったらかしてたプログラムのドキュメント作り。
オーバーロード(メソッドの多重定義)好きなものだから、関数がやたら多くてコメントを打つのが大変。
使いやすいクラスも大事だけど、シンプルなクラスもメンテナンスが楽でいいのかもしれない。


雑に作ったクラス群に一つ一つコメントをつけるのも面倒なので、
使ってないクラスをプロジェクトから外す。
これでコメントを打つ量が減る。


微妙に方向の違う努力だけど、まぁ、よしとする。


すごい勢いでコメントが増加するヘッダーファイルを見て、
できあがるドキュメントはきれいだけど、
実際のヘッダーファイルはコメントだらけで見にくいなぁ、
と思いました。



実際の業務なら、正確なドキュメントが求められるだろうけど、
これは大学の研究で使ったソースコードだからなぁ。