Riverside Learning LABO(Skill/Idea/Code)

よりよいシステムのため工学系と人間系の学習下書きメモ

doxygen & graphviz ソースドキュメント化

doxygen & graphvizによるソースコードのドキュメント化------------------------------------------------------------------------
■使用目的
・コードのドキュメントを納品物に
・コード・リーディング補助etc

doxygen
コードからドキュメントを生成。
1.要素(クラス、関数、変数、マクロetc)をリファレンス化。
2.(JavaDoc,QTstyle)を利用可能。
3.要素間の関係をgraphvizを用いて図示

URL :www.doxygen.org
ライセンス:GPL
対応OS :Windows, MacOSX, Linux
対応言語 :C++, C, Java, Objective-C, Python, IDL,
Fortran, VHDL, PHP, C#, D
出力形式 :HTML, RTF, LateX, man など

graphviz
「DOT言語(グラフ表示言語)」のスクリプトから各種グラフ画像を生成するツール群。
dot :有向グラフ生成ツール
neato:無向グラフ生成ツール
twopi:放射状グラフ生成ツール
circo:環状グラフ生成ツール
fdp :無向グラフレイアウトツール
dotty:グラフ編集用GUIツール

URL :www.graphviz.org
ライセンス:CPL