この記事は、旧システム用に書かれたものです。
本システムでは正常に表示されない可能性があります。ご了承ください。

Doxygenメモ

Doxygen(どきしじぇん)が今熱い！
大学時代のプロジェクトの授業で、開発リーダーさんから一瞬だけ教えてもらったツールなのですが、ふと思い出したので改めて使ってみました。ので、自分メモ。

Doxygen(日本語公式)は、C++などのコメントから、HTMLのドキュメントファイルを作成してくれるプログラムです。
例えばソースコード中に

/**
@fn int func(int a, int b)
@brief aとbをごにょごにょします。
@param[in] a 引数1
@param[in] b 引数2
@retval int ごにょごにょした結果
@date 2009/06/11
@version 1.00
@author Hau-kun
@note サンプルです。
*/

と関数ヘッダを書いておくと、内容がきれいに整形され、ファイルごとにリンクが作成されたりしたHTMLファイルが作成されます。
これを公開すれば、それがそのままプログラム仕様書になります。

丁度、Horo2用のDirectX9ライブラリ for C++を作成している最中だったので、これは来たと思い導入してみました。
まだ詳しい使い方とか、上記の感じで正しいのかとかは不明なのですが、使っていくうちに慣れていこうと思います。
ナレッジベースをどっかに構築したいなぁ。

あと、PHPにも対応しているようなので、β開発中のカブリバシステムにも使えそうかなー。
うまく使えれば、これから使い道がたくさんありそう。

リンク：
Doxygen(日本語公式)
Doxygen 環境設定（日本語公式）
Doxygen 特殊コマンド（日本語公式）