「マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。
目次 †
概要 †
- Doxygenは、フリーのソースコードからのドキュメント生成ツール。
- Doxygenは、プログラムの構造とコメントを元に、ドキュメント生成する。
- さらに、Graphvizというツールを組み合わせて使うことで、
クラスや関数、ファイルの関係を図にして表示することが可能。
- Java、C、C++、C++/CLI、C#、PHP、Fortranなどに対応（VBでは利用できない）。
- 以下のような、クロスリファレンス的情報もアウトプットする。
- 下位メソッドから上位メソッドを辿ることが難しい（上位メソッドは図に出力されない）。
- 仮想関数呼び出しがある場合、インスタンス型を特定できないため、派生クラスのメソッドから基本クラスのメソッドを辿れなくなる。
入手方法 †
以下からダウンロードして下さい。
手順 †
インストール †
いずれもデフォルトのインストールで問題ありません。
設定ファイルを開く †
- 添付のZIPをダウンロードして任意のフォルダに解凍します。
doxygen.zip
- Doxygenを起動し、[File]メニューの[Open]を選択します。
- \doxygen\work内の任意の設定ファイルを開きます。
設定を行う †
- Doxygenの[Wizard]タブの設定を行います。
- project：Project name、Project version or id
- Doxygenの[Expert]タブの設定を行います。
- Input：INPUT_ENCODING
ソースを配置する †
- \doxygen\Code以下のフォルダにソースファイルを配置します。
- CPPフォルダ：C,C++,VC++
- Javaフォルダ：Java
- CSフォルダ：C#
ドキュメントを出力する †
- Doxygenの[Run]タブの[Run doxygen]ボタンを押下します。
- \doxygen\outフォルダ以下に結果が出力されます。
その他 †
設定 †
- 設定は、以下のタブから行います。
- [Expert]タブがconfigurationのフルセットになっています。
- 設定値を確認するには、
[Run]タブの[Show configuration]ボタンを押下して下さい。
- 設定の保存
- Doxygenを起動し、[File]メニューの[Save]・[Save as...]を選択します。
マニュアル †
詳しくは以下のサイトを参照下さい。
サンプル †
以下のサイトはDoxygenで生成したドキュメントのサンプルです。
FAQ †
- doc形式で出力できないか？
- DoxgenでRTF形式で出力し、Wordで参照することが可能です。
- JavaDoc?のHTMLのイメージを変えずに doc形式で出力できないか？
- DocFlex?というツールで、JavaDoc?のイメージを崩さないでRTF形式で出力できそうです。
- ライセンス(Limited Free / 30-day license )に問題が有るようなら、
PDFDoclet(LGPL)も考えられる（未評価）。
- ローカル変数を出力したい。
- 出来ないようなので、メソッド内コメントでの対応を検討下さい。
- メソッド内コメントでの対応も一般的な解決策であるようです。
- /*! ～コメント～ */でメソッド中コメントを記述可能。
- VC++で結果が正しく表示されない。
- __declspecのキーワードで解析エラーが起きるようです。
- 以下のプリプロセッサ設定が必要になるようです。
- ENABLE_PREPROCESSING = YES
- MACRO_EXPANSION = YES
- EXPAND_ONLY_PREDEF = YES
- PREDEFINED = __declspec(x)=
Tags: .NET開発, :ドキュメンテーション, :CI
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
