Doxygen

javadocのようなドキュメント作成ツール． ホームページ．サポート言語は

C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), 
Fortran, VHDL, PHP, C#, and to some extent D

だそうだ．すごいね．手元のubuntuにはなぜだか入っていた．入れた記憶はないのだが． 出力フォーマットもゆたかで，HTML，latex のほかに，RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, Unix man pageをサポート．

使い方

doxygen -f conf

とやると巨大なコンフィギュレーションファイルができる．デフォルトではhtmlとlatexができるようになっている．当面latexはいらないので，

GENERATE_LATEX  = yes

をno に変更．PROJECT_NAME にプロジェクトの名前を，INPUTに入力ファイルのあるディレクトリを指定．何も指定しないと，カレントディレクトリのみになる．EXTRACT_ALLをyesにしとくと，コメントの無いクラスもドキュメントを作ってくれるので最初はyesにしたほうがいいかもしれない．

で，

doxygen conf

でOK

ドキュメントの書き方

C++の場合，クラスやメソッドの前にスラッシュ3つで始まるコメントとして書く．ほかにもJavaDocスタイルとか，いろいろな書き方をサポートしているようだ．

/// this is a class
class a {
public:
  /// this ia a method
  void b();
};

これでOK. 便利．

Pythonの場合は，Python 標準のドキュメントの書き方でOKらしい．