Doxygen是一個(gè)編寫(xiě)軟件參考文檔的工具。該文檔是直接寫(xiě)在代碼中,因此比較容易保持更新。 Doxygen 可以交叉引用文檔和代碼,使文件的讀者可以很容易地引用實(shí)際的代碼。Doxygen的開(kāi)發(fā)作為方便和訪問(wèn)文件系統(tǒng)的C,C,Java中的Objective-C,Python中,IDL,并在一定程度上的PHP,C#和D。
Doxygen功能介紹:
Doxygen已經(jīng)支持生成ANSI編碼的chm目錄文件(index.hhc)!Doxygen通常是用作生成英文文檔的,生成中文文檔需要修改輸入和輸出的碼制,這樣可以改變解析方式,生成中文文檔。但是,你必須意識(shí) 到,Doxygen在從注釋中抽取信息是需要做語(yǔ)法解析的,這些解析都是基于英文的基礎(chǔ),不可能在這個(gè)層面上支持中文。
Doxygen 是一個(gè) C++, C, Java, Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D語(yǔ)言的文檔生成器?梢赃\(yùn)行在大多數(shù)類(lèi)Unix系統(tǒng),以及Mac OS X操作系統(tǒng)和Microsoft Windows 。 初始版本的Doxygen借鑒了一些老版本DOC++的代碼;隨后,Doxygen源代碼由Dimitri van Heesch重寫(xiě)。
Doxygen更新日志:
Doxygen 1.8.4 改進(jìn)了跨引用、語(yǔ)法高亮和通過(guò) LLVM/clang 解析源碼來(lái)獲取調(diào)用圖表的特性,支持 DocBook 輸出和解析 UNO IDL 文件,此外還包含一些小改動(dòng)和提升以及 bug 修復(fù)。
Doxygen使用方法:
下載和安裝 Doxygen
下載最新的Doxygen安裝程序,然后安裝。這個(gè)軟件包包括了一個(gè)GUI界面的前端工具,可以幫助我們方便創(chuàng)建Doxygen配置文件和生成目標(biāo)文檔。
下載和安裝 chm 編譯器
我們使用微軟古老的 HTML Help Workshop 1.3,這個(gè)軟件N久沒(méi)更新了。
下載后根據(jù)提示安裝。
項(xiàng)目一般設(shè)置
首先在“Wizard”標(biāo)簽的Project項(xiàng)進(jìn)行如下設(shè)置:
項(xiàng)目名稱(chēng):將在最新的文檔首頁(yè)中顯示
源碼列表:選擇要生成文檔的源代碼或目錄,可以有多個(gè)文件或目錄形成一個(gè)列表。建議使用相對(duì)路徑,相對(duì)于當(dāng)前目錄(也即當(dāng)前配置文件所在的目錄)
遞歸掃描:如果需要對(duì)整個(gè)源碼目錄下的所有子目錄及文件生成文檔,請(qǐng)勾選本項(xiàng)
輸出目錄:設(shè)置最終生成的幫助文檔的存儲(chǔ)路徑,建議使用相對(duì)路徑
下一步,Mode項(xiàng),根據(jù)需要設(shè)置文檔生成模式。
下一步,Output項(xiàng),設(shè)置輸出格式,勾選HTML和“prepare for compressed HTML(.chm)”
然后切換到“Expert”標(biāo)簽的“HTML”項(xiàng),設(shè)置HTML和CHM相關(guān)的選項(xiàng):
GENERATE_HTMLHELP:確保已經(jīng)勾選了
CHM_FILE:最終生成的.chm的文件名,如“HkcProjectHelp.chm”。默認(rèn)為“index.chm”?梢允褂寐窂,也可以使用相對(duì)路徑,相對(duì)于上面設(shè)置的輸出目錄的html目錄(建設(shè)使用上一級(jí)目錄,如“..\MyDoc.chm”)
HHC_LOCATION:chm 編譯器(hhc.exe)的全路徑。請(qǐng)指到 HTML Help Workshop 的安裝目錄的 hhc.exe 程序
CHM_INDEX_ENCODING:chm索引文件編碼,下面會(huì)講到,這里填“GBK”
編碼設(shè)置
編碼設(shè)置很重要,如果設(shè)置不當(dāng),生成的文檔會(huì)出現(xiàn)亂碼。因?yàn)?Doxygen 汲及的東西多,有好幾項(xiàng)編碼設(shè)置,所以需要認(rèn)真對(duì)待,根據(jù)項(xiàng)目的實(shí)情情況設(shè)置。
所有高級(jí)設(shè)置(包括編碼設(shè)置)都在“Expert”標(biāo)簽,重要的設(shè)置項(xiàng)如下:
Project/DOXYFILE_ENCODING:當(dāng)前 Doxygen 配置文件本身的字符編碼,默認(rèn)為UTF-8,一般不需要修改
Project/OUTPUT_LANGUAGE:輸出語(yǔ)言。這里是指Doxygen自己生成的導(dǎo)航、提示、幫助等文本的文字采用的語(yǔ)言。我們希望幫助文檔是全中文的,所以選擇Chinese

Input/INPUT_ENCODING:輸入文件的編碼。這里是指我們的源代碼文件本身的編碼。在Windows平臺(tái)一般是系統(tǒng)編碼(GBK),而Linux平臺(tái)一般是UTF-8。請(qǐng)用文本編輯器查看源文件的編碼。這里如果設(shè)置的不一致,源碼文件的注釋中所有非ASCII字符將在生成的文檔中變成亂碼。
HTMP/CHM_INDEX_ENCODING:這里設(shè)置Doxygen生成的CHM索引文件的編碼,以前是不能設(shè)置的,默認(rèn)為UTF-8,而微軟的編譯器不能識(shí)別UTF-8編碼的索引文件,所以最終造成左邊目錄導(dǎo)航欄亂碼。我們?cè)O(shè)置它為GBK,這樣Doxygen將為我們生成GBK編碼的索引文件(.hhc、.hhk、.hhp)
生成CHM文檔
設(shè)置好了后,點(diǎn)擊“Run”→“Run doxygen”生成最終的.chm文檔,如果設(shè)置正確,打開(kāi)后是全中文的了。
- PC官方版
- 安卓官方手機(jī)版
- IOS官方手機(jī)版















Workspace ONE 22.09.1.0Workspace ONE-22.09.1.0 中文版
靈卡面板v1.8.6 最新版
海政通信創(chuàng)版PC端電腦版
聯(lián)想掃描王電腦版1.0.0.4 官方版
聚連會(huì)議電腦版1.8.3.12 官方pc版
中通寶盒電腦版8.20.4 官方版
展訊通客戶端電腦版1.0.9 官方版
不坑盒子word插件最新版
精臣云打印電腦版3.10.3 官方最新版
極連快傳PC版1.1.0 官方版
WPS Office 2019專(zhuān)業(yè)增強(qiáng)版11.8.2.11718 集成序列號(hào)版
XMind思維導(dǎo)圖2022綠色破解版12.0.3 免費(fèi)版
天翼云電腦(政企版)1.37.0 官方版
StickyNote桌面便簽0.9 電腦版
OfficePLUS插件(微軟ppt模板插件)官方最新版
公文寫(xiě)作神器(含1800公文模板+素材庫(kù))2.8.2.21 免費(fèi)版
永中office2019電腦版9.0.1480.131 個(gè)人免費(fèi)版
Skylark文本編輯器v2.0.6 中文綠色版
wps2019去廣告純凈版11.8.2.11019 特別版
wps2022秋季更新版11.1.0.12763 官方版
spss26和諧版(IBM SPSS Statistics 26)中文破解版
金山文檔電腦版3.7.9 官方正式版
石墨文檔pc版3.2.0 正式版
釘釘電腦客戶端7.0.0.60533 最新版
語(yǔ)雀客戶端1.3.5 官方PC版
閃布辦公軟件3.3.3 官方版
迅捷pdf轉(zhuǎn)換器免費(fèi)版8.9.4.1 最新版
筆神寫(xiě)作電腦版3.1.12 官方pc版
壹寫(xiě)作電腦版4.9.8 官網(wǎng)PC版
橙瓜碼字pc版1.6.9 官方版
蘇寧聚力(LionLink)客戶端1.1.1電腦版
wps office 2020官方正版13.0.503.101 正式版【64位】
teamviewer企業(yè)破解版15.10.5 免費(fèi)版
多益云企業(yè)通訊辦公平臺(tái)2.5.000 官方最新版
哨子辦公電腦客戶端4.1.58 官方版





visio2021(Microsoft Visio 2021專(zhuān)業(yè)增強(qiáng)版
office2021安裝包(Office 2021 LTSC專(zhuān)業(yè)增強(qiáng)
office2007破解版安裝包64位+破解教程
office2010 32位安裝包官方免費(fèi)版
office2016專(zhuān)業(yè)增強(qiáng)版(Microsoft Office Pr
wps2024專(zhuān)業(yè)增強(qiáng)版(wps office 2024)12.1.0
office2016中文免費(fèi)版64位官方版
office2010安裝包(Office Professional Plu
wps官方下載(wps office 2026個(gè)人版)12.1.0
office2021永久破解版(Microsoft Office 20