C#ソースコードからヘルプ形式「CHM(HTMLヘルプ)」のドキュメントを自動で作成してくれるツールとして、「Sandcastle Help File Builder（SHFB）」があるが、クラスの関係図を出力してくれない。Doxygenは、GraphVizと連携することでクラス図とコールグラフを作成でき、HTML Help Workshopを利用することでヘルプ形式のドキュメントも作成できます。また、 mscgen記法でシーケンス図の記述でき、XMLコメントも解析できます。多数の言語に対応し、Windows、Mac、Linux 上で動作し、ドキュメントの出力形式も豊富で、HTMLを基本とし、LaTeX、XML、CHM(HTMLヘルプ)、PDF など、様々なファイル形式をサポートしています。
Doxygenのインストール
今回は、次に示すソフトウェアをインストールし、クラス図とコールグラフを作成し、ヘルプ形式「CHM(HTMLヘルプ)」のドキュメントを作成します。
- Doxygen
- Graphviz
- HTML Help Workshop
Graphvizのインストール
Graphviz は DOT というスクリプト言語によって、グラフを作成するツールで、Doxygen はクラスダイアグラムを生成する機能を持っていて、そこで Graphviz を利用します。今回は Windows 環境にインストールするので、Stable and development Windows Install packages を選びます。
Doxygenのインストール
ダウンロードページの A 32-bit binary distribution for Windows XP/Vista/7 という欄にある、doxygen-1.7.6.1-setup.exe の横にインストーラのリンクがあります。
HTML Help Workshopのインストール
HTML Help Workshopはhtmlhelp.exe をダウンロードします。HelpDocs.zip と htmlhelpj.exe はツールに関するドキュメントです。
Doxygen の設定および実行
Doxygen を設定して実行するために、 スタートメニューから「doxygen」→「Doxywizard」を選択して、GUI ツール「Doxywizard 」を起動すると、次の画面が表示されます。
ドキュメントの作成
解析対象とするソースコードとドキュメントの出力先は、WizardタブのSource code directoryとDistination directoryのそれぞれに次のように設定します。
ドキュメント作成を実行するには、Runタブを開き、Step1でWork用のフォルダを指定し（例ではc:\temp
）、Rundoxygenボタンを押す。Runタブの表示を次に示す。Output produced by doxygenに実行状態が表示される。
THML形式でDoxygenにより作成されたドキュメントが出力先に出力される。index.htmlをクリックし、Namespacesを選択すると次のように表示されます。ここまででは、クラス図とコールグラフはまだ作成されない。
Doxygenによるクラス図とコールグラフの作成
Graphvizを用いてクラス図とコールグラフを作成するために、ExportタブのDotを選択し、ダウンロードしたGraphvizをDoxygenに次のように設定します。
次のようにクラス図が作成されます。
DoxygenによるCHM形式のドキュメント作成
CHM形式のドキュメントを作成するために、ExportタブのHTMLを選択し、次のようにダウンロードしたHTML Help Workshopを設定します。
次のようにヘルプファイルが作成されます。
作成されたドキュメントの日本語化
現状のままだと英語のドキュメントになるので日本語化します。設定はExpertタブのTopicがProjectでOUTPUT_LANGUAGEをJapaneseにします。
英語のドキュメントが次のように日本語で作成されます。
