2009/10/26

VB6でDoxygen

VB6をレガシーコードからモダンコードに移行させるには、
ユニットテストとコードドキュメント生成が必須となる。
今回は、コードドキュメント生成をDoxygenで行う。
といっても、Doxygen単体ではVB6コード扱えない。
そこでC風コードや、Java風コードに変換しなければならない。
いくつか試した中でも、 vbfilter.py が一番精度が高かったので以後EXEとして利用する。
  1. Doxygenをセットアップ
    本家からセットアップバイナリを落として、セットアップ






    とりあえず、必要なのはDoxywizardのみ。後はお好きにどうぞ。









  2. Doxygenファイルを作成する
    作成には、メニューのDoxywizardを実行する


    プロジェクト概要を設定する。
    設定しておくのは、プロジェクト名くらいかと。


    生成対象ソースコード形式を設定する。
    vbfilterの仕様では、C++に設定する。


    出力フォーマットを設定する。
    出力オプションはお好みでどうぞ。


    グラフ出力等にGraphvizを利用する場合は、設定する。
    ちなみに、Doxygen自体にもグラフ出力機能は同梱されている。


    プロジェクト詳細情報を設定する。
    DOXYFILE_ENCODING値をUTF-8にしないと出力出来ない模様


    bas、cls、frmを追加する。
    ※INPUT_FILTER値には、それぞれvbfilter.exeを設定する

  3. VB6なコードを記述する
    記述仕様:
    • クラス概要は、!@brief
    • メソッド、オブジェクト、変数概要は、*@brief
    • メソッド引数は、*@param
    • 覚書は、@note
    • グラフは、@dot

  4. ドキュメントを生成する
    実行すると、Warning等と進捗がログ表示される
    出力先は、設定ディレクトリ下「html」ディレクトリになる


    プロジェクト名が出力されている


    クラス一覧。クラス概要が出力されている


    クラスメソッド一覧


    概要コメントが出力されている


    グラフ出力、各種詳細コメントが出力されている

0 件のコメント: