Rest Term

Doxygen

最近は真面目に研究してます。
とはいっても理論的な進捗はないんですが;;
研究室に蓄積されているCの遺産の改修作業ばかりしてます。
危険なコードがたくさんあったり、あるはずのヘッダがなぜかなかったりでなにがなんだか、、、

昨日ふとチーム内で使うプログラムの管理を真面目にしようと思って、C/C++でもJavadocやASDocのようにドキュメント生成できないかなと調べてみたらやっぱりありました。
Doxygen
書き方も基本的にJavadocと同じ書式で書けばいいようです。

↓のようなドキュメントが生成されます。言語はC++。
(見慣れない引数の型はOpenCVで利用される基本構造体のものです)

TeX形式でも出力可能なので、論文のTeXファイルと一緒に残しておけますね。

ただ、*(ポインタ)とか&(リファレンス)を型名の横にくっつけて書いてもドキュメント上だと離れてしまいます。const double& a が const double &aみたいに。。もしかしたらこれはツール側の設定で変えられるのかもしれませんが。

ドキュメントを作ってる時は少しは現実逃避になるのでオススメです。

あわせて読む:

 

Tags: ,

Comments

No comments so far.

  • Leave a Reply
     
    Your gravatar
    Your Name