【Windows】Doxygenをインストールして使う

スポンサーリンク

Doxygenはソースファイルのコメントから文書を抜き出してドキュメント化するツール。Windowsにインストールして使えるようにしたので備忘録を残す。

インストール

Doxygen

下記URLからWindows用のインストーラを入手して実行。基本デフォルトでOK。

Doxygen: Downloads
Source code documentation and analysis tool

Graphviz

下記URLからWindows用のインストーラを入手。

Download

画像01

安定版をダウンロード。

画像02

インストーラを実行。

画像03

画像04

画像05

[Everyone] を選択して、あとはデフォルトで進める。

  • Graphvizをインストールすると、関数のコールグラフやクラスのUML表現が可能になるので、インストールしておく。

使い方

ドキュメント作成したいソースのあるフォルダに移動し、CMDシェルから下記コマンドで設定ファイル(Doxyfile)が作成される。

> doxygen -g
  • 必要に応じて、作成されたDoxyfileを編集して調整する。

実行

CMDシェルから下記のようにコマンド実行すると カレントディレクトリにあるDoxyfileを読込み、ドキュメント生成する。

$ doxygen

結果は、「html/」フォルダに出力されてるので、その中の index.html をブラウザで開く。

補足

  • GUIからの実行も可能。手順は、参考3.を参照。

関連記事

Doxygen [新石器Wiki]

参考

  1. Doxygen マニュアル
  2. Doxygen – Wikipedia
  3. Doxygenを利用して、コードコメントからドキュメントを作ろう! Githubとの連携も出来るよ!
  4. DoxygenとGraphvizでコードのドキュメントを自動生成する
  5. 最近覚えた便利アプリ[doxygen]
  6. Doxygen入門の入門

コメント

タイトルとURLをコピーしました