ブログトップ 記事一覧 ログイン 無料ブログ開設

大人になったら肺呼吸 RSSフィード Twitter

2012-03-31

Doxygen+GraphvizでVC++のソースからドキュメントを自動生成する

f:id:replication:20120331003802p:image

はじめに

Doxygenというツールを使うと、ソースコードからドキュメントを自動生成することができます。DoxygenはJavaでいうところのJavaDocのようなものです。

この記事では、Doxygen+GraphvizでVisual Studio(C++)で作成したプロジェクトからドキュメントを自動生成する方法について紹介します。

ドキュメント自動生成ツール【A HotDocument】 Studio
ハローシステム (2002-07-08)
売り上げランキング: 48,303

ソフトウェアのバージョン
  • Windows 7
  • Visual Studio 2008
  • Doxygen 1.8.0
  • Graphviz 2.28.0
Doxygenのセットアップ

Doxygenの入手とインストールについては以下のエントリを参照してください。

Graphvizのセットアップ

Graphvizの入手とインストールについては以下のエントリを参照してください。

Doxygen+GraphvizでVC++で作成したソースのドキュメントを自動生成する

1.スタートメニューを選び、すべてのプログラムからdoxygen−Doxywizardを選びます。

f:id:replication:20120331004705p:image

2.DoxywizardでExpertタブを選択し、OUTPUT_LANGUAGEに"Japanese"を選びます。これで自動生成されるドキュメントが日本語になります。

f:id:replication:20120331004706p:image

3.TopicsからBuildを選択し、EXTRACT_ALLにチェックを入れます。

f:id:replication:20120331004707p:image

4.TopicsからLaTexを選択し、GENERATE_LATEXのチェックを外します。デフォルトではLaTex形式のドキュメントも生成してくれるのですが、必要なければ外してしまって構いません。

f:id:replication:20120331005453p:image

5.TopicsからDotを選択し、HAVE_DOTとCALL_GRAPHにチェックを入れます。

f:id:replication:20120331005719p:image

6.メニューからFile−Save Asと選択してDoxyfileを保存します。このとき、ファイルの保存先はVisual Studioのプロジェクトがある場所を選びます。(.cppのソースがある場所)

7.Runタブを選択し、Run doxygenボタンをクリックします。

f:id:replication:20120331010212p:image

8.Doxygen has finishedと表示されたら自動生成は完了です。Show HTML outputボタンをクリックすると、ブラウザが起動して、生成されたドキュメントを確認することができます。

f:id:replication:20120331010432p:image

自動生成されたドキュメントには、ファイル一覧や関数一覧などがありますが、特にインクルード依存関係図が秀逸です。こんな感じの図が一瞬でできあがります。

f:id:replication:20120331011345p:image

これをExcelで書く手間などを考えると、Doxgenを使わない手はないです。

おわりに

以上で、Doxygen+GraphvizでVisual Studio(C++)で作成したプロジェクトからドキュメントを自動生成する方法の説明は終わりです。Doxygenでは、Javadocのように特定のコメントをソースコード中に書くと、それを拾ってドキュメントを生成する機能があります。ただ、doxygenコメントを書いていないプロジェクトでも、インクルード依存関係図は生成してくれるので、VC++で開発しているチームはぜひとも1度、doxygenを使ってみてください。


関連エントリ

仕様書作成係仕様書作成係 2012/10/26 12:04 読ませていただきました。
大変参考になりました。
これからも、良い情報の発信をしていだければ勉強になります。
ありがとうございました。

私も会社でHotDocumentを使って仕様書はいつも自動的に作っています。
http://www.hotdocument.net/
画面レイアウトなども自動作成できます。
もし、よろしければ参考にしていただければ幸いです。

投稿したコメントは管理者が承認するまで公開されません。

スパム対策のためのダミーです。もし見えても何も入力しないでください
ゲスト


画像認証