2008年8月14日 星期四

Doxygen and Graphviz

要由原始程式碼產生文件資料,需要安裝2個套件,分別為Doxygen及Graphviz。

(1)Doxygen套件是產生類別,屬性及函式功能說明文件之文件產生器程式庫,可協助程式設計者將特定格式之註解裡的說明文件導出,產生說明文件,目前Doxygen支援的程式語言包含C++/C/Java/Object-C/Python/IDL/Fortran/VHDL/PHP/C#等程式語言,產生出的文件格式可以是HTML/LATEX/PDF/RTF/PS/...等等。
如果你是Vim的愛用者,那可以再加個美化doxygen註解的外掛,如下圖:(2)Graphviz套件可以將指定格式的結構化資訊,轉換為抽象圖形或網路圖形,在Doxygen套件裡的圖形處理,是引用這個套件來產生類別階層圖。
當你使用Graphviz的套件又有在Doxygen裏設定好後啊,你就可以看到如下圖的結果當然啦,還沒有強到把整個程式的流程圖畫給你看,但最少把Caller跟Callee畫出來給你看囉,算是還蠻不錯的啦。

Fedora安裝
yum install doxygen doxygen-doxywizard graphviz graphviz-doc

Ubuntu安裝
apt-get install doxygen doxygen-doxywizard graphviz graphviz-doc

Windows就要自己去下載囉
http://www.stack.nl/~dimitri/doxygen/download.html
http://www.graphviz.org/Download_windows.php


蠻不錯的Windows的安裝使用教學
Doxygen文件產生器(一)安裝
Doxygen文件產生器(二)設定

Doxygen syntax coloring in Vim

Examples of output generated by doxygen

如果想了解如何寫doxygen的註解,請參考下面的網頁,如果連過去是亂碼,請手動調整"編碼"為繁體中文即可
Doxygen簡介

沒有留言: