Doxygen中文版(編程工具輔助)

Doxygen的開發(fā)作為方便和訪問文件系統(tǒng)的C、C++、、Java中的Objective-C、Python中的IDL，并在一定程度上的php、C＃和D。歡迎需要的朋友在綠色資源網(wǎng)免費(fèi)下載使用！

Doxygen軟件介紹

Doxygen是一種開源跨平臺的，以類似JavaDoc風(fēng)格描述的文檔系統(tǒng)，完全支持C、C++、Java、Objective-C和IDL語言，部分支持PHP、C#。注釋的語法與Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以從一套歸檔源文件開始，生成HTML格式的在線類瀏覽器，或離線的LATEX、RTF參考手冊。

程序語言

C/C++

Java

Objective-C

Python

IDL (Corba, Microsoft及KDE-DCOP類型)

Fortran

VHDL

PHP

C#

文件格式

HTML

XML

LaTeX

RTF (MS-Word)

PostScript

Unix Man Page

doxygen 教程

由于只是工具的使用，這里不介紹它的原理，直接從使用步驟開始。Doxygen的使用步驟非常簡單。主要可以分為：

1）第一次使用需要安裝doxygen的程序

2）生成doxygen配置文件

3）編碼時(shí)，按照某種格式編寫注釋

4）生成對應(yīng)文檔

doxygen的安裝非常簡單， linux下可以直接下載安裝包運(yùn)行即可，下載源代碼編譯安裝也是比較通用的編譯安裝命令。請參考其安裝文檔完成安裝。

Doxygen在生成文檔時(shí)可以定義項(xiàng)目屬性以及文檔生成過程中的很多選項(xiàng)，使用下面命令能夠產(chǎn)生一個(gè)缺省的配置文件：

doxygen -g [配置文件名]

可以根據(jù)項(xiàng)目的具體需求修改配置文件中對應(yīng)的項(xiàng)，具體的修改過程在下面介紹。修改過的配置文件可以作為以后項(xiàng)目的模板。

讓doxygen自動產(chǎn)生文檔，平常的注釋風(fēng)格可不行，需要遵循doxygen自己的格式。具體如何寫doxygen認(rèn)識的注釋在第3節(jié)詳細(xì)介紹。

OK，代碼編完了，注釋也按照格式寫好了，最后的文檔是如何的哪？非常簡單，運(yùn)行下面的命令，相應(yīng)的文檔就會產(chǎn)生在指定的目錄中。

doxygen [配置文件名]

需要注意的是doxygen并不處理所有的注釋，doxygen重點(diǎn)關(guān)注與程序結(jié)構(gòu)有關(guān)的注釋，比如：文件、類、結(jié)構(gòu)、函數(shù)、變量、宏等注釋，而忽略函數(shù)內(nèi)變量、代碼等的注釋。