Doxygen, what?
Doxgen就是大名鼎鼎的文檔生成工具秕重,而且是免費開源的不同,它使用非常方便,能提取C++溶耘,Java二拐,Objective-C,Python凳兵,IDL百新,PHP,C#等語言的注釋庐扫,從而生成文檔饭望。
你可以訪問其官方網站,下載安裝包聚蝶,它的官網上有詳細的使用手冊杰妓。
一、問題的產生
當分析一個很復雜的項目源代碼時碘勉,如何有效的分析函數間的調用關系呢?從網上搜索到了如下方法:使用doxygen和graphviz來自動分析函數間的調用關系桩卵。
二验靡、工具簡介
doxygen:
是一種從標記過的C++源代碼生成文檔的標準工具,也支持C雏节,Objective-C胜嗓,C#,PHP钩乍,Java辞州,Python,IDL寥粹,Fortran变过,VHDL埃元,Tcl等。
graphviz:
是一種開源的將結構化信息展示成抽象圖和網絡的工具媚狰,用于網絡岛杀,生物信息,軟件工程崭孤,數據庫和網站設計类嗤,機器學習以及其他技術領域的可視性接口。
三辨宠、生成函數調用圖
1遗锣、下載并安裝以下兩種工具
doxygen:(http://www.stack.nl/~dimitri/doxygen/index.html)
graphviz:(http://www.graphviz.org/)
注意下載時,選擇的是windows版本嗤形,還是mac版本黄伊。
如果安裝過程中彈出“打不開 XXX,因為它來自身份不明的開發(fā)者”請進入如下網址尋找解決辦法:
http://jingyan.baidu.com/article/f71d60377960651ab741d140.html
2派殷、運行DoxyWizard还最,彈出Doxygen配置界面
選擇Scan recursively則遞歸分析源代碼目錄中的子目錄內的源代碼。
由于使用到了Graphviz毡惜,所以要設置Dot選項拓轻,勾選HAVE_DOT,并設置DOT_PATH為Graphviz的bin目錄经伙。(注意:MAC的Graphviz的bin目錄不在安裝包內扶叉,一般是在/usr/local/bin/,實在找不到就到終端用ls一層一層的查找)
另外,若Doxygen出現中文亂碼問題:
設置如下:
Expert選項卡-> Project:
DOXYFILE_ENCODING:UTF-8
OUTPUT_LANGUAGE:Chinese
Expert選項卡-> InPut:
INPUT_ENCODING:GB2312
這樣生就可以正確生成含有中文的文檔了帕膜。
原文:http://www.reibang.com/p/fe4b6b95dca5
相關閱讀: