ドキュメントの作成って、面倒ですよね。私は、コメントを先に書いて、それから、コードを書くことが多く、コメントを付けること自体は、それほど億劫ではありません。そこで、doxygenを使ってみました。使ってみると、これはかなり、便利ですね。対象は、c++のコードで、javadoc形式でコメントを書きました。doxygenを実行すると、当然ですが、きれいに成形されたHTML形式のAPI仕様書ができあがりました。若干、Doxyfileを変更する必要があったりしたので、簡単に使い方をメモっておくことにします。
まず、下記サイトより、Windows版のインストーラ、doxygen-1.5.4-setup.exeをダウンロードします。
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
インストーラの指示に従って、doxygenをインストールします。
次に、下記コマンドで、設定ファイルを生成します。
>doxygen -g
すると、Doxyfileという設定ファイルが生成されます。
自分の環境に合わせて、Doxyfileを編集します。
私が変更したのは、下記の8か所です。
DOXYFILE_ENCODING = SHIFT_JIS PROJECT_NAME = XXX OUTPUT_LANGUAGE = Japanese INPUT_ENCODING = SHIFT_JIS GENERATE_LATEX = NO INPUT = D:/svn/src/ D:/svn/include/ OUTPUT_DIRECTORY = D:/svn/doc/doxygen/vm/ MULTILINE_CPP_IS_BRIEF = YES
日本語環境なので、DOXYFILE_ENCODINGとINPUT_ENCODINGにSHIFT_JISを設定します。OUTPUT_LANGUAGEには、Japaneseを設定します。INPUTには、元となるソースの場所を指定します。複数指定する場合にはスペースで区切ります。OUTPUT_DIRECTORYにAPI仕様書が生成されます。LATEX形式の文書は必要ないので、GENERATE_LATEXにはNOを設定しました。
後は、ソースコードにjavadoc形式でコメントを付けて、下記コマンドを実行するだけです。
>doxygen
なお、私は下記のサイトを参考にしました。
DOXYFILE_ENCODING = SHIFT_JIS
は、REEORになります。
本当にドキュメント生成でいたのか疑わしい!