Doxygen

自分はソースにコメントを書いていない。全然書いていない。
さすがにソースを他人に渡すときには書くけれども、ソースを書いている途中はほとんど書いていない。


だってコメント書くのめんどいしー(´σ `) ホジホジ


いやマジで。
基本的に携帯アプリのソースは一人で書くので、どの変数がどんな意味を持っているかなんて分かってるので、自分のためのコメントは必要ない。
だからコメントを書く場合は、他人が見て理解できるかどうか、というのを考えながら書くことになる。
でもそんなことをすると、今までプログラミング中にキャッシュしていた内容がいくつか消えてしまう。というか自分の脳内キャッシュ量は非常に少ないので、全部消える。
そんなことをするぐらいなら、全部書き終わった後に、一気にコメントを書く方が全然効率が良い。


で、コメントを書くときに活躍するのがDoxygen
こういうドキュメント化ツールは、非常に便利だと思う。


一定の形式で書かれたコメントをドキュメント化するトランスレータを開発するのは(自分のレベルでは)難しい。
まずは設計。どの言語に対応させるか。どんなフォーマットで記述するか。そのフォーマットに矛盾はないか。そのフォーマットで内容を把握することは出来るか。そのフォーマットからどの形式で出力するか。
次にプログラミング。バグはないか。そのバグが設計段階でのバグであれば、設計からやり直し。
そして保守。バグが出た。対応したい言語が増えた。出力したい形式が増えた。GUIが欲しくなった。バグが出た←それは仕様です。etc...。


考えるだけで頭が痛い。実際はもっとたくさんの問題が出るだろう。これに時間を費やすぐらいならやっぱり、Doxygen等の既存のドキュメント化ツールを使うべきだと思う。
もし出力する形式を増やしたかったら、Doxygen形式で書かれたコメントを解析するか、もしくはHTML等の出力された形式を変換すればいい。一から考えるより全然楽だし、元々がDoxygenフォーマットだから、Doxygenで出力することも可能だ。


という思考の結果の末、Doxygenを使ってみることにします。