Home | Lesson | Game | Tool | Link

ドキュメント作成（Doxygenの使用方法）

ドキュメントの生成方法として、Doxygenを使用した方法を紹介します。

20080419
INPUT_ENCODINGでの問題点と対策方法を追記。
日本語に関する何かしらの問題が発生した場合は、
INPUT_ENCODINGに「cp932」を指定してください。

バッチファイルを使用した際に、DOS画面を閉じないようにする方法を追記。
バッチファイルの最後に「pause」を記述してください。

Doxygenとは
ドキュメント生成ツールです。
ソースコード中にDoxygenのルールに従ってコメントを記述することで、
専用のコマンドを使用してドキュメントを生成することができます。
Doxygenでは、クラスの継承関係やファイルのインクルードの関係を示すことも可能です。
それには、Graphvisを使用して、関係をわかりやすく画像にする必要があります。
ドキュメントと図で表すので、かなりわかりやすくなります。

ダウンロード
2008/03/01時点での最新バージョン
最後にで表記したものは、実際にダウンロードしたものです。
Doxygen | 日本語での紹介ページ 1.5.5　[doxygen-1.5.5-setup.exe]
Graphvis(画像生成ツール) 2.16.1　[graphviz-2.16.1.static.exe]

インストール
・Doxygenのインストール
　デフォルトの設定では、C:\Program Files\doxygenにインストールされます。
　上記以外にインストールしたい場合は、変更してからインストールしてください。
　ここでは、デフォルトのままで行います。
・Graphvizのインストール
　デフォルトの設定では、C:\Program Files\Graphviz2.16にインストールされます。
　上記以外にインストールしたい場合は、変更してからインストールしてください。
　ここでは、デフォルトのままで行います。

設定方法
以下に、簡単な設定方法を記述します。
1.Doxywizardの起動
　起動すると、以下の画面が表示されます。ここで使用する場所の紹介をします。
　1-1.Wizardボタン：基本設定を行います。
　1-2.Expertボタン：詳細設定を行います。
　1-3.Working Directoy：作業ディレクトリ（ドキュメントを作成したいディレクトリ）を指定。
　以降、詳細を記述します。

2.Wizardでの基本設定
　Source code directoryにドキュメントを作成したいディレクトリを指定します。
　設定したら OK ボタンを押して、Expertの設定に移ります。


3.Expertでの詳細設定：Projectの設定
　3-1.エンコードタイプを SJIS に指定します（出力される文字コードを指定します）。
　　※Windowsでは基本的にはShiftJISのため。
　　　SJISに設定しないとソース中のコメント（日本語）が正しく変換されません。
　　　ソース中のコメントが英語だけなら UTF-8 のままで構いません。
　3-2.コメント以外のタイトルなどで使用する言語を Japanese に指定します。
　　※タイトルが英語でも構わない場合は English のままでも大丈夫です。


　3-3.タブのサイズを 4 に設定します。


4.Expertでの詳細設定：Buildの設定
　4-1.EXTRACT_ALLにチェックをして、全てを抽出するようにします。


5.Expertでの詳細設定：Inputの設定
　5-1.入力ファイルを SJIS に設定します。
　　※Windowsでは基本的にはShiftJISのため。

　SJISでの問題点
　・デストラクタの「~」を削除してしまう。
　・SJIS/Shift_JISを指定してもまだ文字化けが起こる。
　このような問題があるため、「cp932」を指定することをお勧めします。
　
　cp932とは…
　SJISの元となったマイクロソフトが規定した「Windows Code Page 932」です。
　日本で一般的に使用しているSJISはcp932を元に作成されています。
　いくらかコードが違うものがあり、500文字程度の漢字や記号などで文字化けが起こります。

6.Expertでの詳細設定：LateXの設定
　6-1.GENERATE_LATEXのチェックを外し、Latexでの出力をしないようにします。


7.Expertでの詳細設定：Dotの設定
　7-1.CLASS_DIAGRAMSにチェックし、クラス図を出力するようにします。


　7-2.DOT_PATHにGraphvizのパスを指定します。
　　ここでは、C:\Program Files\Graphviz2.16\binを指定します。
　　全て設定したら OK ボタンを押します。


8.ドキュメント実行
　8-1.Save ボタンを押して、設定ファイルを保存します。
　8-2.Start ボタンを押して、ドキュメントを生成します。
一度設定すると、Doxyfileが作成されます。
2回目以降は、Load ボタンを押して、読み込むとよいでしょう。
ただ、毎回Doxywizardを起動させるのは面倒なので、
バッチファイルを作成して実行する方法も紹介します。


ドキュメント作成（Doxygen起動）バッチ
txtファイルを用意して、中身を以下のように記述します。
doxygen Doxyfile

cd html
index.html

pause

作成したら、docmake.batと名前を変更しておきます。
docmake.batを実行することで、Doxygenを実行し、index.htmlを開きます。

メモ
バッチファイルの最後にpauseと記述すると、何かキーを押すまでDOS画面が閉じなくなります。
こうすることにより、ドキュメント作成時に起きた問題を確認することが可能です。