強大的Doxygen工具使用手冊

張三：假如我們自己開發了一個類庫，怎麼做一個方便閱讀的文檔呢？

李四：一個方法一個方法地寫唄，就像寫Excel文檔一下。

張三：啊，你out了，這多慢呀。為什麼不玩玩doxygen工具，它能幫你產生文檔？

李四：這麼爽，什麼東東，給說講講。

1. Doxygen, what？

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

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

http://www.doxygen.nl/index.html

支援的主要語言格式

Extension	Language
.idl	IDL
.ddl	IDL
.odl	IDL
.java	Java
.cs	C#
.c	C
.cpp	C++

可產生出來的文檔格式有：

• HTML
• XML
• LaTeX
• RTF
• CHM
  

要讓工具能提取注釋，那麼就要求你寫的注釋要按照一定的規則來寫，不能亂寫，不然該工具是無法識別的，通常在Java中，只要JavaDoc能識別的，doxgen也能識別。

2. 安裝Doxygen

我們可以在這個網址去下載最新的安裝包

http://www.doxygen.nl/download.html#latestsrc

安裝過程就不用說了，很簡單，直接Next，最後Finish就OK了。

3. 配置Doxygen

配置doxgen是最核心的，你可以設定你要提取注釋的源檔案，產生的文檔格式，工程名稱，文檔的Logo等資訊，這些配置是可以儲存起來的，當你的原始碼更新後，重新再運行這個設定檔，就可以重建一個新的文檔。

在安裝後，進入到其安裝目錄下的bin檔案夾，它裡面有兩個檔案：doxygen.exe和doxywizard.exe，我們先運行doxywizard.exe來進行配置，從而組建組態檔案（如果是第一次運行）。

圖1，Doxygen配置主介面。

1，Doxygen工作目錄，就是用來儲存設定檔的目錄。

2，遞迴搜尋目錄需要選上。

圖2，選擇輸出文檔格式

圖3，產生類圖

圖4，選擇文檔的編碼格式。

說明：編碼格式，UTF-8 是首選。如果需要顯示中文則選擇GB2313。

圖5，設定提取的範圍。

圖6，設定源碼的格式。

圖7，設定產生CHM檔案屬性。

圖8，配置完成後，點擊"Run doxygen"來回合組態，最後，點擊File->Save儲存設定檔，下次就不用再配置了。

4. 輸出文檔樣本

下面的圖片樣本了輸出的文檔格式（HTML），很簡單實用，同時還能支援Search。

圖9，列出所有的包名。

 

圖10，具體某一個類的詳細注釋，可以列出所有的公有方法，你的代碼注釋寫得越詳細，那麼產生的文檔也就越詳細。