doxygen使用教（jiāo）程-文檔生成工具(Doxygen)1.8.10 官網最新版

Doxygen是一個編寫軟件參考文（wén）檔的工具。該文檔是（shì）直接寫在代碼中，因此比較容易保持更（gèng）新。Doxygen可以交叉引用文檔和代碼，使文件的讀者可以很容易地引用實際（jì）的代碼。Doxygen的開發作為（wéi）方便和訪問文（wén）件係（xì）統的C，C，Java中的Objective-C，Python中，IDL，並在一定程度上的PHP，C＃和D。解壓物語遊戲下載-解壓物語（yǔ）遊戲1.0 安卓版

Doxygen使（shǐ）用（yòng）方法：

下載和安裝Doxygen

下載最新的Doxygen安裝程（chéng）序，然後安裝。這個軟（ruǎn）件包包括了一個（gè）GUI界麵的前端工具（jù），可以幫助www.17c.com方便創建Doxygen配置（zhì）文件和生成目標文檔。

下載和安裝chm編譯器

www.17c.com使用（yòng）微軟古老的HTMLHelpWorkshop1.3，這個軟件N久沒更新了（le）。

下載後根據提示（shì）安裝。

項目一般設置

首先在“Wizard”標簽（qiān）的Project項進行如下（xià）設置：

項目名稱：將在最新的文檔首頁中顯示

源碼（mǎ）列表：選擇要生成文檔的源代碼或目錄（lù），可以有多個文件或目錄形成一個列表。建議使用相對路徑，相對於當（dāng）前目錄（也即當前配置（zhì）文件所（suǒ）在的目錄）

遞歸掃描：如果需要對（duì）整個（gè）源碼目錄下的所有子目錄及文（wén）件生成文檔，請勾（gōu）選本項

輸（shū）出目錄（lù）：設置（zhì）最終生成的幫助（zhù）文檔的存儲路徑，建議（yì）使用（yòng）相對（duì）路徑

下一步，Mode項，根據需要設置文檔生成模式。

下一步，Output項，設置輸出格式，勾選HTML和“prepareforcompressedHTML(.chm)”

然後切換到“Expert”標簽的“HTML”項，設置HTML和CHM相關的（de）選項：

GENERATE_HTMLHELP：確保已經勾選（xuǎn）了

CHM_FILE：最終生成的.chm的文件名，如“HkcProjectHelp.chm”。默認（rèn）為“index.chm”。可以使用路徑（jìng），也可以使用（yòng）相對（duì）路徑，相對於上麵設置的輸出目錄的html目錄（建設使用（yòng）上（shàng）一級目錄，如“..MyDoc.chm”）

HHC_locations：chm編譯器（hhc.exe）的全路徑。請指到HTMLHelpWorkshop的安裝目錄的hhc.exe程序

CHM_INDEX_ENCODING：chm索引文件編碼，下麵會講到，這裏填“GBK”

編碼設置

編碼設（shè）置很重要，如果設置（zhì）不當，生成的文檔會（huì）出現亂碼。因為Doxygen汲及的東西多，有好幾項編（biān）碼設置，所以需要認真對待，根據項目的實情情況設置（zhì）。

所有高級設置（包括編碼設置）都在“Expert”標簽，重要的設置項如（rú）下：

Project/DOXYFILE_ENCODING：當前Doxygen配置（zhì）文件本身的字（zì）符編碼，默（mò）認為UTF-8，一般不需要修改

Project/OUTPUT_LANGUAGE：輸出（chū）語言。這裏是（shì）指Doxygen自己生成（chéng）的導航、提示、幫助等文本的文字采用（yòng）的語言。我（wǒ）們希望（wàng）幫助文檔是全中文的，所以選擇Chinese

Input/INPUT_ENCODING：輸入文件的編碼。這裏是指我（wǒ）們的源（yuán）代碼文（wén）件本身（shēn）的編碼。在Windows平台一般是（shì）係統編碼（GBK），而Linux平台一般是（shì）UTF-8。請用文本編輯器查看源文（wén）件的編碼。這（zhè）裏如果設置的不一致，源碼文件的注釋中所有非ASCII字符將在生成的文檔中變（biàn）成（chéng）亂碼。

HTMP/CHM_INDEX_ENCODING：這（zhè）裏設置Doxygen生成的CHM索引文件的編碼，以前是不能設置（zhì）的，默認為（wéi）UTF-8，而微軟的編譯（yì）器不能識別UTF-8編碼的索引文件，所以最（zuì）終（zhōng）造成左邊（biān）目錄導航欄亂（luàn）碼。www.17c.com設置它為GBK，這樣Doxygen將為我（wǒ）們生成GBK編碼的索（suǒ）引文件（.hhc、.hhk、.hhp）

生成CHM文檔

設置好了後，點擊“Run”→“Rundoxygen”生成最終的.chm文檔，如（rú）果設置正確，打開後是全（quán）中文（wén）的（de）了。

Doxygen更新日（rì）誌：

Doxygen1.8.4改（gǎi）進了跨引用、語（yǔ）法高亮和通過LLVM/clang解析（xī）源碼來獲（huò）取調用圖表的特性，支持DocBook輸出和解析（xī）UNOIDL文件，此外還（hái）包含一些小改動和提升（shēng）以及bug修複。

Doxygen功能介（jiè）紹：

Doxygen已經支持生（shēng）成（chéng）ANSI編碼的chm目錄（lù）文件（index.hhc）！Doxygen通常是用作生成英文文檔的，生成中（zhōng）文文檔需要修改輸入和輸出的碼（mǎ）製，這樣可以改變解析方式，生成中文文檔。但是，你必須意識到，Doxygen在從注釋中抽取信息是需要做語法解析（xī）的，這些解析都是基於英文的基礎（chǔ），不可能在這個層麵上支持中文。

Doxygen是一個（gè）C++,C,Java,Objective-C、Python、IDL(CORBA和Microsoftflavors)、Fortran、VHDL、PHP、C#和（hé）D語言的（de）文檔生成器。可以運行在大多（duō）數類Unix係統，以及MacOSX操作係統和MicrosoftWindows。初始版本的Doxygen借鑒了一些（xiē）老版本DOC++的代碼；隨後，Doxygen源（yuán）代碼由DimitrivanHeesch重寫。