doxygen
doxygen
プログラム・ドキュメント・ジェネレータ
綺麗なプログラムとは何だろうか。バグが少ないプログラムとは何だろうか。日夜パソコンの画面とにらみ合いをしながらプログラムを書き続けている人にとっては永遠の問題かも知れない。
個人的にはやはりコメントの量に一つの答えがあるのではないかと思う。プログラムにとってコメントとは、説明であり注意であり備忘録である。人の記憶は永遠ではなく、時と共に失われるものだ。その中にあってコメントはその時の記憶を留めておける重要な楔（くさび）だ。
本日紹介するオープンソース・ソフトウェアはそんなコメント達を更に有効活用できるテクノロジーを持っている。doxygen、プログラム・ソースを読み込んでドキュメントを生成してくれるオープンソース・ソフトウェアだ。
ドキュメントを生成するにあたって、基礎的な書き方はある。有名なJavaDoc、Qt等のスタイルに対応している。スタイルはどうあれ、各クラスや関数に対しての説明書きが必要なのは当たり前なので、それの書き方が固定されるだけの話だ。寧ろ正しい書き方が定義される事で書きやすくすらある。
出力できるフォーマットはHTML、LATEX、RTF、PostScript、PDF、圧縮HTML、Unix man等。様々な用途に対して適用できそうだ。こういったソフトウェアは様々にあるが、ドキュメント生成用のテクノロジーだけ切り離す事で、様々な言語に対して一定のルールが適用できるようになりそうだ。
コメントは決して無用な存在ではない。言わば作業の足跡なのだ。出来るプログラマーは言われずともコメントを残してきた。そのコメントを更に活用できる、それ程素晴らしい事はない。あ、ちなみに読み方は『ドクシゲン』だよ、トム。