（轉）Doxygen文檔生成工具

　　http://blog.csdn.net/lostaway/article/details/6446786

 

Doxygen 是一個支持 C/C++，以及其它多種語言的跨平臺文檔生成工具。如同 JavaDoc, doxygen 直接從源文件中提取符合 doxygen 註釋規範的註釋，生成文檔^[1]。 

一、安裝

1.1 安裝 Doxygen 1.7.4(Windows)

地址：ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin.zip

 

1.2 安裝 graphviz 2.28.0(Windows)

地址：http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.28.0.msi

 

graphviz 是一個由AT&T實驗室啓動的開源工具包，用於繪製DOT語言腳本描述的圖形^[2]。Doxygen 使用 graphviz 自動生成類之間和文件之間的調用關係圖，如不須要此功能可不安裝該工具包。

 

1.3 安裝 Windows Help Workshop 1.32

地址：http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe

 

這個工具就很少說了，生成 CHM 幫助文檔的。 Doxygen 使用它生成 CHM 格式的文檔。

 

二、配置

運行 Doxywizard 開始配置

Doxygen 1.7.4 主界面以下圖 1 所示。

 

說明：

Doxygen 工做目錄(1:) 就是用來存放配置文件的目錄，別無它用。

 

選擇 wizard 標籤下的 Output Topics

相關配置說明以下圖 2 所示。

 

 

選擇 wizard 標籤下的 Diagrams Topics

相關配置說明以下圖 3 所示。

 

若是以前安裝了 Graphviz 工具包，就可啓用該選項。

 

選擇 expert 標籤下的 Project Topics

相關配置說明以下圖 4 所示。

 

說明：編碼格式，UTF-8 是首選。

 

選擇 expert 標籤下的 Input Topics

相關配置說明以下圖 5 所示。

 

 

說明：

輸入的源文件的編碼，要與源文件的編碼格式相同。若是源文件不是UTF-8編碼最好轉一下。

 

 

選擇 expert 標籤下的 HTML Topics

相關配置說明以下圖 6 所示。

 

說明：

若是在 Wizard 的 Output Topics 中選擇了 prepare for compressed HTML (.chm)選項，此處就會要求選擇 hhc.exe 程序的位置。在 windows help workshop 安裝目錄下能夠找到 hhc.exe。

 

 

在 Expert 標籤中還有超多的選項，須要按本身的要求去定製。我的喜愛問題就再也不贅述了，你們能夠查 doxygen 文檔啥的，裏面有每一個選項的詳細介紹。

 

選擇 Run 標籤

相關配置說明以下圖 7 所示。

 

 點擊 Run doxygen 按鈕， Doxygen 就會從源代碼中抓取符合規範的註釋生成你定製的格式的文檔。接下來的工做就是學習 doxygen 的註釋規範了，參考 《doxygen 快速入門》第 2 節 「經常使用註釋語法」。慢慢的就能夠體會到 doxygen 的方便性。

 

Doxygen 生成 CHM 文檔亂碼的問題

因爲 Windows 的默認編碼不是 UTF-8， Doxygen 生成的 CHM文件目錄和文件標題欄是亂碼。通常解決步驟能夠參考《doxygen 快速入門》關於解決目錄亂碼的問題。這裏要補充的一點就是，最好將 index.hhc、index.hhk 、index.hhp都轉爲 UTF-8格式。這樣標題欄啥的也不會是亂碼了。

參考

[1] http://zh.wikipedia.org/wiki/Doxygen Wikipedia-doxygen

[2] http://zh.wikipedia.org/wiki/Graphviz Wikipedia-graphviz

[3] http://hi.baidu.com/soulmachine/blog/item/6055ad017a9a1606738da58c.html doxygen 快速入門

 

附錄

補充幾張效果圖：