ソース解析

今日は、参考のためにここのソースを読んだり、クラス構成を調べたりしました。

で、その時にソースの解析に、Doxygenを使ってみました。

Doxygenはご存知の方はご存知と思いますが、ソースを解析してhtmlやPDFのドキュメントを生成してくれるツールです。クラス図やコラボレーション図なんかも生成してくれます。C/C++だけでなく、JavaやPHP、C#等にも対応しています。

というわけでその時のメモをば、

以下、作業はWindowsでやっています。

インストール

DoxygenからWindows用のインストーラをダウンロードしてきて、インストールします。

また、図を生成するためには、Graphvizも必要なので、これもダウンロードしてインストールします。

設定

インストールが終わったら、Doxygenと、GraphvizのbinディレクトリにPATHを通しておきます。

使い方

以下、Dos窓で作業します。

適当な作業ディレクトリで

doxygen -g

とすると、Doxyfileという設定ファイルの雛形が作成されます。設定ファイル名は指定も可能です。

生成された設定ファイルを適当に編集します。

PROJECT_NAME = プロジェクト名
INPUT = ソースパス # 解析するソースの場所

OUTPUT_DIRECTORY = 出力先 # ブランクの場合はカレント

OUTPUT_LANGUAGE = Japanese # 出力言語

EXTRACT_ALL = YES # doxygenの書式で書かれていないソースを適当に処理させる

EXTRACT_PRIVATE = NO # プライベートメンバも出力する場合はYES

EXTRACT_STATIC = NO # スタティックメンバも出力する場合はYES

EXTRACT_〜 # 他いろいろ



GENERATE_HTML = YES # HTMLの出力

GENERATE_LATEX = NO # Latex用の出力をする場合はYES



HAVE_DOT = YES # graphvixを使って図を描かせる場合はYES

※これ以外にDoxywizardというGUIなツール(一緒にインストールされます)を使って設定することも可能です。

実行

doxygen

作業状況がコンソールに表示されます。特にエラーが表示されなければ成功です。

生成されたindex.htmlを見てみましょう。

クラス階層や関数の呼び出し順序など見やすく整形してくれてます。いやー、これ便利ですね。

もっと便利に使うためには、やはりDoxygenの記法に沿ったコメントの記述を心がけねばですね。