EclipseforC/CPP 之配合 doxygen + graphviz 生成HTML代碼文檔

JAVA語言中的代碼註釋那是至關好的一個東西，尤爲是使用了Eclipse以後，簡直是程序員的福音。小弟前幾天用了一下午的時間，通過在網上的查找以及我一點點的探索，終於搞定在windows平臺下，使用 Eclipse for c/cpp + doxygen + graphviz 自動提示代碼註釋以及生成HTML格式的文檔。

 

還不知道doxygen的同窗，請自行百度/Google

 

聲明：JDK以及mingw的安裝和配置請自行解決，這裏的測試以C語言爲主

 

使用到的軟件：

jdk

mingw

eclipse for c/cpp

doxygen

eclox

graphviz

 

1、安裝doxygen、graphviz以及eclipse插件：eclox

doxygen、graphviz的安裝比較簡單，就是典型的下一步，再也不贅述。

而後就是在eclipse【其實是 Eclipse IDE for C/CPP ，如下簡稱爲 eclipse】中安裝doxygen的插件 eclox了，它的下載地址 http://home.gna.org/eclox/

至於 eclipse 安裝插件的方法，這裏推薦使用 link 安裝方法，具體的做法再也不多說

安裝好以後，還要作一些設置：

一、window->preferences->doxygen

在右側點擊 Add,添加doxygen安裝目錄的bin目錄

這一步的目的是爲了在eclipse中使用和本地安裝的doxygen是同一個

二、window->preferences->C/C++->Editor

在右側最下方的 Workspace default中選擇：Doxygen

若是沒有這一步的話，是不會像在eclipse中對JAVA的文檔註釋支持一個，輸入/**回車以後，會自動出現 @param @return 等

 

2、代碼註釋的書寫：

在doxgyen中，有不少相似於JAV中@param等註解同樣的特殊命令字，實際上，當咱們使用doxgyen的特殊命令字的時候，若是使用@param強制聲明，那看起來和JAVA的註解好像也沒有什麼不同，這其實就是doxygen對於java-dox的兼容了。

當咱們建立好一個頭文件後，應當在文件的前面加上：@file，不然在生成的HTML文檔中，是不會出現該文件的

當咱們寫好一個函數後，好比：

Stu stu_create(int stu_id, char stu_name[20], double stu_score_math,

double stu_score_english, double stu_score_computer);

那麼就能夠像在eclipse中寫JAVA註解同樣寫C語言的註釋了。在函數的上面一行輸入：/**，回車以後，你就會發現：

/**

 * 

 * @param stu_id

 * @param stu_name

 * @param stu_score_math

 * @param stu_score_english

 * @param stu_score_computer

 * @return

 */

這些全是自動出現的，至於具體的註釋怎麼寫，就看你本身了

其中param是參數， return是返回值，還有其它的特殊命令字，能夠看doxygen的幫助文檔：Doxygen Documentation，這個文件能夠在開始菜單中看到

 

3、工程的設置以及HTML文檔的生成：

在項目上右鍵新建，選擇 Other doxyfile，

基本設置

 

在Basic頁面中的設置：

 

Project

Name:項目名稱，多個單詞須要用雙引號括起來，不能夠是中文，不然運行出錯

Version or Identifier:項目的版本

 

Output Formats:

選中HTM中的with frames and navigation tree，不然輸出中沒有搜索

取消LaTex

選中Man Pages

 

Mode:

選中documented entities only和Incluce cross-refrenced source code in the output，能夠在輸出中查看函數定義在第幾行

在 Optimize results for 中選擇語言

 

中文支持設置 

 其實doxygen 是支持中文的，只是咱們須要設置一下而已。另外，若是是須要製做CHM格式的文檔，也是須要修改編碼的

在Advanced 頁面中，在Custom中輸入enco，把 Doxyfile Encoding 和 Input Encoding 的值都修改成源代碼的編碼

在custom的中輸入output，把Output Language 的值修改成 Chinese

函數調用示意圖設置【須要安裝graphviz】

 

在custom中輸入：call

把Call Graph 和 Caller Graph 的值都修改成 YES

 

在custon同輸入 dot，

把Have DOT 設置爲Yes

把DOT Path 的值設置爲graphviz的bin 目錄 

4、生成文檔

 如今能夠按Ctrl+S保存這個doxyfile文件，而後在工具欄上單擊那個@符號，或者能夠在工程上右鍵，也是有的，名字是 Build Documention，若是是第一次建立文檔，它會讓你選擇一個deoxyfile文件

若是沒有指定輸出目錄的話，那麼在eclipse中，它默認是在當前目錄下生成一個html目錄，在html目錄下，會有一個index.html文件，用瀏覽器打開就能夠看到文檔了

曬一下個人文檔：