はじめに
Doxygenというツールを使うと、ソースコードからドキュメントを自動生成することができます。DoxygenはJavaでいうところのJavaDocのようなものです。
この記事では、Doxygen+GraphvizでVisual Studio(C++)で作成したプロジェクトからドキュメントを自動生成する方法について紹介します。
売り上げランキング: 48,303
ソフトウェアのバージョン
- Windows 7
- Visual Studio 2008
- Doxygen 1.8.0
- Graphviz 2.28.0
Doxygen+GraphvizでVC++で作成したソースのドキュメントを自動生成する
１．スタートメニューを選び、すべてのプログラムからdoxygen−Doxywizardを選びます。
２．DoxywizardでExpertタブを選択し、OUTPUT_LANGUAGEに"Japanese"を選びます。これで自動生成されるドキュメントが日本語になります。
３．TopicsからBuildを選択し、EXTRACT_ALLにチェックを入れます。
４．TopicsからLaTexを選択し、GENERATE_LATEXのチェックを外します。デフォルトではLaTex形式のドキュメントも生成してくれるのですが、必要なければ外してしまって構いません。
５．TopicsからDotを選択し、HAVE_DOTとCALL_GRAPHにチェックを入れます。
６．メニューからFile−Save Asと選択してDoxyfileを保存します。このとき、ファイルの保存先はVisual Studioのプロジェクトがある場所を選びます。（.cppのソースがある場所）
７．Runタブを選択し、Run doxygenボタンをクリックします。
８．Doxygen has finishedと表示されたら自動生成は完了です。Show HTML outputボタンをクリックすると、ブラウザが起動して、生成されたドキュメントを確認することができます。
自動生成されたドキュメントには、ファイル一覧や関数一覧などがありますが、特にインクルード依存関係図が秀逸です。こんな感じの図が一瞬でできあがります。
これをExcelで書く手間などを考えると、Doxgenを使わない手はないです。
おわりに
以上で、Doxygen+GraphvizでVisual Studio(C++)で作成したプロジェクトからドキュメントを自動生成する方法の説明は終わりです。Doxygenでは、Javadocのように特定のコメントをソースコード中に書くと、それを拾ってドキュメントを生成する機能があります。ただ、doxygenコメントを書いていないプロジェクトでも、インクルード依存関係図は生成してくれるので、VC++で開発しているチームはぜひとも1度、doxygenを使ってみてください。
