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

Doxygen的開發作為方便和訪問文件係統的C、C++、、Java中的Objective-C、Python中的IDL，並在一定程度上的php、C＃和D。歡（huān）迎需要的（de）朋（péng）友在綠色資源網免費（fèi）下載使用！

Doxygen軟件介紹

Doxygen是一種開（kāi）源跨平台的，以類似JavaDoc風格描述的文檔係統，完全支持C、C++、Java、Objective-C和IDL語言，部分支（zhī）持PHP、C#。注釋的語（yǔ）法（fǎ）與（yǔ）Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以從（cóng）一（yī）套歸（guī）檔源文件開始，生成HTML格式（shì）的在線類瀏覽器，或離線的LATEX、RTF參考手（shǒu）冊。

程序語言

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 教（jiāo）程

由於隻是工具的使用（yòng），這裏不介紹它的原理，直接從使用步驟開始。Doxygen的使用步驟非常簡單。主要可（kě）以分（fèn）為：

1）第一次使用（yòng）需要安裝doxygen的程序

2）生成doxygen配置文件

3）編碼時，按照某種格式編寫注釋（shì）

4）生成對應文檔

doxygen的安（ān）裝非常簡單， linux下（xià）可以直（zhí）接（jiē）下載安裝包運行即可，下載源代碼編譯安（ān）裝也是比較通用的編譯安裝命令（lìng）。請參考其安裝文（wén）檔完成安裝。

Doxygen在生（shēng）成文檔時可以定義項目屬性以及文（wén）檔生（shēng）成過程中的（de）很多選項，使用（yòng）下麵命令能（néng）夠產生一個缺（quē）省的配置文件：

doxygen -g [配置文件名]

可以根（gēn）據項目的（de）具體需求（qiú）修改配置文件（jiàn）中對應的項，具體的修改過程在下麵介（jiè）紹。修改（gǎi）過（guò）的配置文件可以作為以後項（xiàng）目的模板。

讓（ràng）doxygen自動產生文檔，平常的注釋風格可不行，需要遵循（xún）doxygen自己的格式。具體如何寫doxygen認識的注釋在（zài）第3節詳細介紹。

OK，代碼編完了，注釋也按照格式寫好了，最後的文檔是如何的（de）哪（nǎ）？非常簡單，運行下麵（miàn）的命令，相應的文（wén）檔（dàng）就（jiù）會產生在指定的目錄中。

doxygen [配置文件名]

需要注意的是doxygen並不處理所有的注釋，doxygen重點關注與程序結構（gòu）有關的注釋，比如：文件（jiàn）、類（lèi）、結構、函數、變量、宏等（děng）注釋，而忽略函數內變量、代碼等的（de）注釋。