Doxygen可以為多種語言生成說明文檔(從程序的源代碼中提取其中按照約定格式寫的注釋中提取信息)
例如C++, Objective-C, C#, C, PHP, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, D ,從這期開始,我將系統地介紹Doxygen的使用,包括以下內容:
- Doxygen安裝和配置
- DOxygen for C++使用說明——注釋代碼一
- DOxygen for C++使用說明——注釋代碼二
- DOxygen for C++使用說明——添加數學公式
- DOxygen for C++使用說明——Markdown支持
安裝
doxygen安裝
我們可以從doxygen官網上下載最新的doxygen軟件,我的是doxygen-1.8.10,然后一路next下去即可。
Graphviz 安裝
Graphviz是大名鼎鼎的貝爾實驗室的幾位牛人開發的一個畫圖工具。
它的理念和一般的“所見即所得”的畫圖工具不一樣,是“所想即所得”。
Graphviz提供了dot語言來編寫繪圖腳本。在doxygen中我們可以使用Graphviz繪制函數調用圖、類的繼承關系圖等各種各樣的圖。
首先先在Graphviz 主頁下載,如下圖:
選擇圖中圈起的版本,然后一路安裝,
注意:一定要記住Graphviz的安裝目錄,以后還會用得著。
HHC.exe安裝
使用Doxygen可以生成多種形式的文件,這里我們選擇生成compressed html(即CHM格式文檔)與latex格式的(即PDF格式文檔),
生成chm文件,需要用到MS HTML Help Compiler,為此我們在HTML Help (CHM) Help Compiler官網下載hhc.exe,然后一路安裝即可。
注意:一定也要記住hhc.exe的安裝目錄,以后還會用得著。
配置
首先先給個福利,此鏈接是我已經配置好的,可以直接使用。
使用方法是:選擇【開始】菜單,打開Doxygen文件夾,選擇Doxywizard程序,然后就出現了以下界面,點擊【File】,選擇【open】,然后:
下面介紹具體的配置方法:
然后
并且我們可以點擊【File】的【Save】保存配置,下一次就可以直接使用了。
參考文獻
- DoxyGEN 的使用與Graphviz 的使用
- 用Doxygen Graphviz生成函數調用流程圖
- 強大的Doxygen工具使用手冊
- Doxygen + Graphviz windows下安裝配置(圖解)