張三:假如我們自己開發了一個類庫,怎么做一個方便閱讀的文檔呢?
李四:一個方法一個方法地寫唄,就像寫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,具體某一個類的詳細注釋,可以列出所有的公有方法,你的代碼注釋寫得越詳細,那么生成的文檔也就越詳細。