一、準(zhǔn)備工作
1、windows 10系統(tǒng)
2、下載doxygen,可以自己從官網(wǎng)下載,如果下不下來可以從我百度云盤下,我下載的是doxygen-1.8.10-setup版本
下載地址:https://pan.baidu.com/s/1BBpc1YSshyHdlDY5lSs8EA
3、graphviz下載,我下載的是graphviz-2.37.20140115版本,
下載地址:https://pan.baidu.com/s/1BfuCMcBQgR0F8MVIH0HI5g
二、安裝
首先安裝Graphviz ,再安裝doxygen,安裝沒什么,一路next就ok了
1、安裝Grapgviz
下載后雙擊安裝,跟著提示安裝即可,安裝后可能在桌面沒有g(shù)raphviz的快捷方式,不過不用擔(dān)心,在我們的開始菜單里面可以找到。開始->所有程序->Grapgviz->gvedit.exe。
安裝在任意喜歡的位置。但是需要把安裝目錄的graphviz/bin加入環(huán)境變量PATH里,我這里只寫了相對(duì)路徑。
打開cmd,輸入:dot –help,如果彈出以下信息,就是安裝成功:
下面我們將使用graphviz手冊(cè)上的一個(gè)小例子進(jìn)行演示。代碼如下:
digraph G{ size = "5, 5";//圖片大小 main[shape=box];/*形狀*/ main->parse; parse->execute; main->init[style = dotted];//虛線 main->cleanup; edge[color = green]; // 連接線的顏色 execute->{make_string; printf}//連接兩個(gè) init->make_string; main->printf[style=bold, label="100 times"];//線的 label make_string[label = "make anstring"]// n, 這個(gè)node的label,注意和上一行的區(qū)別 node[shape = box, style = filled, color = ".7.3 1.0"];//一個(gè)node的屬性 execute->compare; }
運(yùn)行結(jié)果如下:
2、安裝doxygen,一路next就行(略)
三、使用
1、配置doxgen
這是最核心的,你可以設(shè)置你要提取注釋的源文件,生成的文檔格式,工程名稱,文檔的Logo等信息,這些配置是可以存儲(chǔ)起來的,當(dāng)你的源代碼更新后,重新再運(yùn)行這個(gè)配置文件,就可以重新生成一個(gè)新的文檔。
在安裝后,進(jìn)入到其安裝目錄下的bin文件夾,它里面有兩個(gè)文件:doxygen.exe和doxywizard.exe,我們先運(yùn)行doxywizard.exe來進(jìn)行配置,從而生成配置文件(如果是第一次運(yùn)行)。
圖1,Doxygen配置主界面。
1,Doxygen工作目錄,就是用來存儲(chǔ)配置文件的目錄。
2,遞歸搜索目錄需要選上。
圖2,選擇輸出文檔格式
圖3,生成類圖
圖4,選擇文檔的編碼格式。
說明:編碼格式,UTF-8是首選。如果需要顯示中文則選擇GB2313。
圖5,設(shè)置提取的范圍。
圖6,設(shè)置源碼的格式。
圖7,設(shè)置生成CHM文件屬性。
圖8,配置完成后,點(diǎn)擊"Run doxygen"來運(yùn)行配置,最后,點(diǎn)擊File->Save存儲(chǔ)配置文件,下次就不用再配置了。