Skip to content

MS_Doxygen

Jump to bottom
nishi_74322014 edited this page Aug 3, 2026 · 1 revision

Doxygen

概要

  • Doxygenは、フリーのソースコードからのドキュメント生成ツール。
  • Doxygenは、プログラムの構造とコメントを元に、ドキュメント生成する。
  • さらに、Graphvizというツールを組み合わせて使うことで、
    クラスや関数、ファイルの関係を図にして表示することが可能。
  • Java、C、C++、C++/CLI、C#、PHP、Fortranなどに対応（VBでは利用できない）。
  • 以下のような、コールグラフ情報もアウトプットする。
    • 下位メソッドから上位メソッドを辿ることが難しい（上位メソッドは図に出力されない）。
    • 仮想関数呼び出しがある場合、インスタンス型を特定できないため、派生クラスのメソッドから基本クラスのメソッドを辿れなくなる。

DoxygenXref

入手方法

以下からダウンロードして下さい。

移行メモ: 元 Wiki が案内していた www.doxygen.jp（日本語ミラー）と www.stack.nl/~dimitri/doxygen/ は、いずれも現在は提供されていない。 上記の現行 URL に差し替えた。

手順

インストール

いずれもデフォルトのインストールで問題ありません。

設定ファイルを開く

  1. 添付の doxygen.zip をダウンロードして任意のフォルダに解凍します。
  2. Doxygenを起動し、[File]メニューの[Open]を選択します。
  3. \doxygen\work 内の任意の設定ファイルを開きます。

doxygen.zip の構成は以下のとおり。

doxygen/Code/CPP/      … C, C++, VC++ のソース配置先
doxygen/Code/CS/       … C# のソース配置先
doxygen/Code/Java/     … Java のソース配置先
doxygen/out/           … 出力先
doxygen/work/C#_Doxyfile（コード有り）  /（コード無し）
doxygen/work/CPP_Doxyfile（コード有り） /（コード無し）
doxygen/work/Java_Doxyfile（コード有り）/（コード無し）

設定を行う

  1. Doxygenの[Wizard]タブの設定を行います。
    • project：Project name、Project version or id
  2. Doxygenの[Expert]タブの設定を行います。
    • Input：INPUT_ENCODING

ソースを配置する

\doxygen\Code 以下のフォルダにソースファイルを配置します。

  • CPPフォルダ：C, C++, VC++
  • Javaフォルダ：Java
  • CSフォルダ：C#

ドキュメントを出力する

  1. Doxygenの[Run]タブの[Run doxygen]ボタンを押下します。
  2. \doxygen\out フォルダ以下に結果が出力されます。

その他

設定

  • 設定は、以下のタブから行います。
    • [Wizard]タブ
    • [Expert]タブ
  • [Expert]タブがconfigurationのフルセットになっています。
  • 設定値を確認するには、
    [Run]タブの[Show configuration]ボタンを押下して下さい。
  • 設定の保存
    • Doxygenを起動し、[File]メニューの[Save]・[Save as...]を選択します。

マニュアル

詳しくは以下のサイトを参照下さい。

サンプル

以下のサイトはDoxygenで生成したドキュメントのサンプルです。

FAQ

  • doc形式で出力できないか？
    • DoxygenでRTF形式で出力し、Wordで参照することが可能です。
  • JavaDocのHTMLのイメージを変えずに doc形式で出力できないか？
  • ローカル変数を出力したい。
    • 出来ないようなので、メソッド内コメントでの対応を検討下さい。
    • メソッド内コメントでの対応も一般的な解決策であるようです。
    • /*! ～コメント～ */ でメソッド中コメントを記述可能。
    • 参考
  • VC++で結果が正しく表示されない。

    • __declspec のキーワードで解析エラーが起きるようです。

    • 以下のプリプロセッサ設定が必要になるようです。

      ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = __declspec(x)=

    • 参考

Tags: .NET開発, ドキュメンテーション, CI

このWikiは「Open棟梁Project」,「OSSコンソーシアム 開発基盤部会」によって運営されています。

NetDevInfraWiki

マイクロソフト系技術情報 Wiki
Open 棟梁 Wiki

（未着手）

開発基盤部会 Wiki

移行管理: DONE ／ TODO

Clone this wiki locally