Doxygen

doxygen.png

これが一番、有名っぽい。
これがあったら、Visual SutudioのXML docを出力する機能、要らないじゃない!と言いたくなる。
しかし、ここで使ったコメントの文法はdoxygenでも有効なのだ。無駄ではないぞ
JavaEclipseをお使いの場合はJavadocというものがある EclipseからJavadocを生成するには?

Doxygenの取得

Downloads

Graphizの取得

Downloads
Doxygen+GraphvizでVC++のソースからドキュメントを自動生成する

ドキュメント生成のためにやること

.cppの存在するフォルダを指定する

Step 1:Specify the working directory from which doxygen will run
て書いてあるところ。.slnファイルのあるとこじゃないよ。
日本語を含むフォルダはできない。
フォルダ階層が複雑なプロジェクトの場合
Input項目のRECURSIVEにチェックをつけるとそのフォルダ以下を自動で再帰的に探索してInputとして認識くれます。

Expertタブにて

  • OUTPUT_LANGUAGE->Japanese en
  • Build->☑EXTRACT_ALL
  • Build->☑EXTRACT_PRIVATE….プライベートメンバも出力する
  • LaTex->□GENERATE_LATEX(チェックを外す。だって、HTMLだけでいいよね。論文書くなら話は別)

Dot項目…図をちゃんと出すため

一番下の方にあるよ

  • ☑HAVE_DOT
  • ☑CALL_GRAPH
  • DOT_PATH→F:/Program Files/Graphviz2.30/binなどとGraphizのバイナリファイルが入っているフォルダを指定すること
  • DOT_PATH→F:/Program Files/Graphviz2.30/binなどとGraphizのバイナリファイルが入っているフォルダを指定すること

エンコードの設定

Windowsの場合、SHIFT_JISって書こう。
可能なエンコード
EUC-JP, SHIFT_JIS, CP932, ISO-2022-JP, ISO-2022-JP-2, ISO-2022-JP-1
更にVisualStudioの場合は
Inputの中にあるINPUT_ENCODINGに「CP932」と文字を打ちます。
CP932というのはMicrosoftなどが拡張したShift-JIS文字コードです。

外部の自作ライブラリも一緒に出力したい場合

Expert->Input

INPUTで外部の自作ライブラリのフォルダを指定しよう。
この時、自分のフォルダも入れるのを忘れずに
あんまりいっぱいすると、大変だよ。

出力先の設定

OUTPUT_DIRECTORYにパスを渡す。
ネットワーク上のフォルダや日本語を含むフォルダは無理だよ。

最後に

いっぱい設定したらDoxyfileをSaveするのがおすすめ

File->Save

だ。

その他、デフォルトにはないけど設定すると良い項目

Expert/Build/EXTRACT_STATIC ->スタティックなメンバもドキュメント化する。
Expert/Source Brouwsew/ SOURCE_BROWSEW->ソースファイルもドキュメント化する

javaの場合

Expert/Build/HIDE_SCOPE_NAMES…..クラスの前にくっついてる長ったらしいpackage名を排除してくれます

その他、状況によって使い分けた方が良いオプション

SHORT_NAMES これをONにすると出力されるファイル名はクラス名ではなく、特殊な省略名になります
CREATE_SUBDIRS これをONにすると、d0eなどのフォルダがたくさんできて、その下に出力ファイルができます

doxyge-configuration
Doxygen特殊コマンド全集


documentation reverse-engineering

サポートサイト Wikidot.com documentationreverse-engineering