1 簡介：

　　Doxygen是一種開源跨平臺的，以類似JavaDoc風格描述的文件系統. Doxgen可以從一套原始檔開始，生成HTML格式的線上類瀏覽器，或離線的LATEX、RTF參考手冊。LATEX也可以轉成PDF. Doxygen 的使用可分為兩大部分。首先是特定格式的批註撰寫，第二便是利用Doxygen的工具來產生檔案。

1.1 語言支援

• C/C++
• Java
• Objective-C
• Python
• IDL (Corba, Microsoft及KDE-DCOP型別)
• Fortran
• VHDL
• PHP
• C#

1.2 生成的文件格式

• HTML
• XML
• LaTeX
• RTF (MS-Word), 可以用作轉pdf
• PostScript
• Unix Man Page

2 安裝

2.1 Ubuntu/Debian安裝

sudo apt-get install doxygen

2.2 原始碼安裝

可在官網下載包: 如doxygen-1.7.4.linux.bin.tar.gz

命令:

tar xvfz doxygen-1.7.4.linux.bin.tar.gz
cd doxygen-1.7.4
./configure
make
sudo make install

3 配置

3.1 生成配置檔案

首先進入到專案目錄（最少是你要生成文件的所有程式碼的父級目錄）:

doxygen -g

該命令會在當前路徑生成一個名為Doxyfile配置檔案.

Doxyfile 檔案內容非常多，大概 1000 多行，不過其中約 4/5 都是註釋，每個配置選項都有一段詳細的註釋。日後，如果對 Doxygen 各配置選項的意義有一定了解，可以在生成配置檔案的命令中新增 "-s" 選項，生成不含註釋的配置檔案，操作如下：

doxygen -s -g

3.2 常用配置

執行完上面的生成命令, 已經有個模板Doxyfile，可以根據需要更改相應設定:

# 專案名稱，將作為於所生成的程式文件首頁標題
PROJECT_NAME           = “Test

# 文件版本號，可對應於專案版本號，譬如 svn、cvs 所生成的專案版本號
PROJECT_NUMBER       = "1.0.0

# 程式文件輸出目錄
OUTPUT_DIRECTORY    =  out/

# 程式文件語言環境
OUTPUT_LANGUAGE    = Chinese

# 如果是製作 C 程式文件，該選項必須設為 YES，否則預設生成 C++ 文件格式
OPTIMIZE_OUTPUT_FOR_C  = YES

# 對於使用 typedef 定義的結構體、列舉、聯合等資料型別，只按照 typedef 定義的型別名進行文件化
TYPEDEF_HIDES_STRUCT   = YES

# 在 C++ 程式文件中，該值可以設定為 NO，而在 C 程式文件中，由於 C 語言沒有所謂的域/名字空間這樣的概念，所以此處設定為 YES
HIDE_SCOPE_NAMES        = YES

# 讓 doxygen 靜悄悄地為你生成文件，只有出現警告或錯誤時，才在終端輸出提示資訊
QUIET   = YES

# 只對標頭檔案中的文件化資訊生成程式文件
FILE_PATTERNS          = *.h

# 遞迴遍歷當前目錄的子目錄，尋找被文件化的程式原始檔
RECURSIVE              = YES

# 示例程式目錄
EXAMPLE_PATH           = example/

# 示例程式的頭文件 (.h 檔案) 與實現文件 (.c 檔案) 都作為程式文件化物件
EXAMPLE_PATTERNS       = *.c *.h

# 遞迴遍歷示例程式目錄的子目錄，尋找被文件化的程式原始檔
EXAMPLE_RECURSIVE      = YES

# 允許程式文件中顯示本文件化的函式相互呼叫關係
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES

# 生成 latex 格式的程式文件
GENERATE_LATEX         = YES

# 在程式文件中允許以圖例形式顯示函式呼叫關係，前提是你已經安裝了 graphviz 軟體包
HAVE_DOT               = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES

#讓doxygen從配置檔案所在的資料夾開始，遞迴地搜尋所有的子目錄及原始檔
RECURSIVE = YES  

#在最後生成的文件中，把所有的原始碼包含在其中
SOURCE_BROWSER = YES

$這會在HTML文件中，新增一個側邊欄，並以樹狀結構顯示包、類、介面等的關係
GENERATE_TREEVIEW ＝ ALL
 

其實基本使用者只需要下面修改5個地方：
1.projectName名字
2.生成的檔案格式，因為只需要html格式的文件，所以搜尋LaTeX，把其輸出改為no即可，就是隻生成html格式的文件．
3.RECURSIVE = YES   這可以讓doxygen從配置檔案所在的資料夾開始，遞迴地搜尋所有的子目錄及原始檔
4.EXAMPLE_RECURSIVE忽略資料夾　EXCLUDE忽略檔案　一般EXCLUDE和EXAMPLE_RECURSIVE配合使用（在文章最下部會有使用例項截圖）
5.mainpage:在mainpage.h檔案中寫完整的檔案路徑才可從mainpage跳轉,但是最後的檔名後邊不能新增類似.java（在文章最下部會有使用例項截圖）

4 填寫註釋

Doxygen就是從原始碼檔案的註釋中提取文件. 所以生成文件之前, 就是要按照Doxygen的風格來編寫註釋，網上一搜會有很多標準的Doxygen註釋規範.（在文章最下部會有java使用例項截圖）

5 程式文件生成

在上面生成的Doxyfile所在的路徑, 輸入

doxygen your-cfg-filename

如果沒有修改名字的話，其實就是

doxygen Doxyfile

your-cfg-filename 是 Doxygen 配置檔名，如果是使用 "doxygen -g" 生成的預設配置檔案 -- Doxyfile，那麼可以在終端裡僅鍵入 "doxygen" 命令即可生成程式文件。

如果按照本文配置, 在out目錄下, 會有html, latex資料夾. 使用瀏覽器開啟html目錄中的 index.html 檔案，即可看到自己的工作成果。

6 轉為pdf

如果裝了latex環境, 到latex下make即可生成pdf. 對於需要中文環境的, 請參考: Linux下Doxygen生成中文pdf文件

7 例項連結地址

https://fossies.org/dox/lucene-7.1.0-src/

８ 參考地址

http://www.doxygen.nl/

http://www.mikewootc.com/wiki/tool/sw_develop/doxygen_get_start.html

9 寄語

這該是比較完整的Doxygen使用，除了註釋規範（網上都有，本文章只有類和方法註釋例項圖一張，在最底部），自己做個筆記，希望對你也有幫助！