もっと愛情を込メント YumemiYougie-Project
■doxygenを使ってみる
実際の仕事などではコーディング規約などでdoxygen形式で〜と指示されるだけで実際にドキュメント化するのは自分ではない場合が多いので、実際ドキュメント化された物を見たことないという場合もあるかもしれません。
されるのを待ってから見て確認し、修正するよりは実際自分でドキュメントを作成して確認してみましょう。
というわけで簡単に doxygen を使う方法を解説してみます。
まず、下記サイトよりWindows版のインストーラをダウンロードします。
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
A binary distribution for Windows XP/Vista/7
の欄。2010/11の時点では doxygen-1.7.2-setup.exe でした。
インストーラの指示に従って、doxygenをインストールします。
大体は「Next」をクリックするだけですがこのサイトを参考にするとよいでしょう。
インストールが終了したら、インストール先(C:\Program Files\doxygen\bin)で下記コマンドを実行して設定ファイルを生成します。
>doxygen -g
Doxyfileという設定ファイルが生成されるので環境に合わせて、Doxyfileを編集します。
大体以下を変更すればOKです。
DOXYFILE_ENCODING = SHIFT_JIS
OUTPUT_LANGUAGE = Japanese
INPUT_ENCODING = SHIFT_JIS
GENERATE_LATEX = NO
PROJECT_NAME = DOCUMENT
INPUT = D:/work/lib/ D:/program/include/
OUTPUT_DIRECTORY = D:/doc/
INPUTには、元となるソースの場所を指定します。複数指定する場合にはスペースで区切ります。
OUTPUT_DIRECTORYには出力先。
この２つは環境に合わせて設定します。
LATEX形式の文書は必要ないので、GENERATE_LATEXには NOを設定しました。
あとは下記コマンドで実行。
>doxygen
INPUT で指定した中にあるソースに対して作成されたドキュメントが OUTPUT_DIRECTORY で指定したフォルダに作成されます。
本格的に使用するなら PROJECT_NAME にプロジェクトの名前を入れましょう。
doxygen.exe を実行するバッチと D:/doc/html/index.html のショートカットを用意すれば
コメント編集->ドキュメント化->確認
が手早く行えます。
をインストールしていれば
HAVE_DOT = YES
とする事でクラス構造などをグラフィカルにする事ができます。
参考