doxygenでドキュメントの自動作成

自動つっても妖精さんが作ってくれるわけではなくて、ソースコード中に特定の書式で書いたコメントを元に、ドキュメントを作成するツール。クラスの階層とか関数、変数の説明とか。

あとgraphvizと連携して図も作ってくれるらしい。クラスの継承図とか。これは素晴らしい。

doxygen

• http://www.doxygen.jp/
• http://www.doxygen.jp/manual.html
• http://www.fides.dti.ne.jp/~oka-t/doxygen.html
• http://blog.s21g.com/articles/1305

doxygen -gでdoxygenの設定ファイル作成して、適当に編集してdoxygenを実行するだけ。うーん、とても簡単。

設定項目

• HAVE_DOT

graphvizを使って図を作成する場合はyesに

perl用のdoxygenfilter

doxygenは元々C/C++とか用の

// コメント
/* 
   これもコメント
*/

という書式のコメントを利用するので、そのままではperlで利用できない。まぁperlは通常pod形式で書いてperldocすればいいんだけど、Cとか他の言語と組み合わせたプロダクトの場合だったら、perlもdoxygen使えたらいいのにな〜と。思いながらgoogle先生に聞いてみたらすでに先人がdoxygen用のfilterを作成していた。まるでポルナレフの気分。

• Documentation

ソースをDLして、perl Makefile.PL; make && make installで。あとはdoxygenの設定で

INPUT_FILTER = doxygenfilter
FILE_PATTERN = *.c *.cpp *.pl

みたいにしてFILTERとdoxygenが検索する拡張子に.plを追加とかすればいい。