doxygenを使おう


doxygenとは

doxygenはC++用ドキュメント生成ツールです。

ソースコード中にdoxygenのルールに従うコメントを書いておくと、コマンドを1回でソースのドキュメントを生成してくれます。これを使うことにより、自分の書いたコードの再利用、他人との作業の効率化を出来る可能性があります。

doxygen 1.3.8、graphvis 1.12を使用しています。

何処で手に入れるか、他に何が必要か

doxygenはhttp://www.doxygen.org/にあります。また、graphvis、http://www.research.att.com/sw/tools/graphviz/も一緒にダウンロードしておきましょう。doxygenはgraphvisを利用してクラス図ヘッダファイルのインクルード図などを生成する機能があるのでこれを利用しないと楽しみが半減です。

どうやって使うか

惑いっぱなしのプログラマのページのDoxygenを使おうを見てください。

僕はこう使っている!

以前使っていたバージョンはSJISが化けるという事が起きていましたが、最新版は大丈夫なようです。なので、特に何も気にしなくても使えいます。

例えば「ぷろじぇくと 絵巻」用の設定ファイルです。関数呼び出しグラフがお気に入りです。

Compressed HTML filesにする

「GENERATE_HTMLHELP」オプションをYESにします。また、doxygenのマニュアルの「GENERATE_HTMLHELP」の所にあるHTML Helpのページへ言って、下の方にあるHTML Help Downloadsのページへ行き、Htmlhelp.exeをダウンロードしてきて、インストールしておきましょう。

その状態でdoxygenを実行します。そうするとドキュメントディレクトリの下のhtmlディレクトリ内に、index.hhpというファイルが出来ています。それを、先ほどHTMLhelp.exeでインストールした、ディレクトリ内にある、hhw.exeで開いてコンパイルするとindex.chmが出来ます。または、HTMLhelp.exeのインストール先ディレクトリへパスを通して置いて、コンソールで

hhc index.hhp

とやってもindex.chmが出来ます。