doxygen+graphviz+doxywizard 提取註釋自動生成文檔

轉載

https://www.jianshu.com/p/b96d29390f69

Doxygen, what？

Doxgen就是大名鼎鼎的文檔生成工具，並且是免費開源的，它使用很是方便，能提取C++，Java，Objective-C，Python，IDL，PHP，C#等語言的註釋，從而生成文檔。

你能夠訪問其官方網站，下載安裝包，它的官網上有詳細的使用手冊。

1、問題的產生

當分析一個很複雜的項目源代碼時，如何有效的分析函數間的調用關係呢？從網上搜索到了以下方法：使用doxygen和graphviz來自動分析函數間的調用關係。

2、工具簡介

doxygen：
是一種從標記過的C++源代碼生成文檔的標準工具，也支持C，Objective-C，C#，PHP，Java，Python，IDL，Fortran，VHDL，Tcl等。

graphviz：
是一種開源的將結構化信息展現成抽象圖和網絡的工具，用於網絡，生物信息，軟件工程，數據庫和網站設計，機器學習以及其餘技術領域的可視性接口。

3、生成函數調用圖

一、下載並安裝如下兩種工具

doxygen：（http://www.stack.nl/~dimitri/doxygen/index.html）

graphviz：（http://www.graphviz.org/）

注意下載時，選擇的是windows版本，仍是mac版本。

若是安裝過程當中彈出「打不開 XXX，由於它來自身份不明的開發者」請進入以下網址尋找解決辦法：

http://jingyan.baidu.com/article/f71d60377960651ab741d140.html

二、運行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

這樣生就能夠正確生成含有中文的文檔了。

---

原文：https://www.jianshu.com/p/fe4b6b95dca5

相關閱讀：

1. http://blog.csdn.net/leehong2005/article/details/9137889
2. https://www.jianshu.com/p/f67ec1879fca
3. http://blog.csdn.net/chenyujing1234/article/details/19115319
4. http://blog.csdn.net/timmy_zhou/article/details/7289742

做者：琯琯 連接：https://www.jianshu.com/p/b96d29390f69 來源：簡書 簡書著做權歸做者全部，任何形式的轉載都請聯繫做者得到受權並註明出處。