マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。

目次

概要

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

入手方法

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

手順

インストール

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

設定ファイルを開く

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

設定を行う

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

ソースを配置する

  1. \doxygen\Code以下のフォルダにソースファイルを配置します。
    1. CPPフォルダ:C,C++,VC++
    2. Javaフォルダ:Java
    3. CSフォルダ:C#

ドキュメントを出力する

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

その他

設定

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

マニュアル

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

サンプル

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

FAQ

  • doc形式で出力できないか?
    • DoxgenでRTF形式で出力し、Wordで参照することが可能です。
  • JavaDoc?のHTMLのイメージを変えずに doc形式で出力できないか?
    • DocFlex?というツールで、JavaDoc?のイメージを崩さないでRTF形式で出力できそうです。
  • ライセンス(Limited Free / 30-day license )に問題が有るようなら、
    PDFDoclet(LGPL)も考えられる(未評価)。
  • ローカル変数を出力したい。
    • 出来ないようなので、メソッド内コメントでの対応を検討下さい。
    • メソッド内コメントでの対応も一般的な解決策であるようです。
    • /*! ~コメント~ */でメソッド中コメントを記述可能。
  • VC++で結果が正しく表示されない。
    • __declspecのキーワードで解析エラーが起きるようです。
    • 以下のプリプロセッサ設定が必要になるようです。
      • ENABLE_PREPROCESSING = YES
      • MACRO_EXPANSION = YES
      • EXPAND_ONLY_PREDEF = YES
      • PREDEFINED = __declspec(x)=

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


添付ファイル: fileDoxygenXref.png 384件 [詳細] filedoxygen.zip 333件 [詳細]

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2017-10-05 (木) 16:42:03 (503d)