doxygen(幫助文檔生成器) linux

doxygen linux是一款開源跨平臺(tái)類似于javadoc風(fēng)格描述的文檔，軟件能夠讓我們的開發(fā)人員輕松為自己的應(yīng)用程序制作各種幫助文檔，完全支持C、C++、java、Object-C等語(yǔ)言，還支持部分的PHP、C#等，是一款非常不錯(cuò)的幫助文檔生成器。
doxygen linux能夠直接從源中提取用戶的注釋，所以用戶的幫助文檔能夠和源代碼保持一致，保證了提取出來(lái)的東西能夠和源代碼保持一致，不管用戶后面如何修改代碼，最后用戶再一次生成幫助文檔的時(shí)候都會(huì)變成最新最準(zhǔn)確的內(nèi)容，用戶完全不需要擔(dān)心出現(xiàn)問題，有需要的程序員可不能夠錯(cuò)過這款強(qiáng)大的軟件哦。

doxygen linux安裝說明

1、編譯安裝
1)  tar xvfz doxygen-1.7.4.linux.bin.tar.gz
2)  cd doxygen-1.7.4
3)  ./configure
4)  make
5)  make install
2、安裝graphviz
1、執(zhí)行如下命令即可完成安裝
yum install graphviz

3、配置使用
1、在項(xiàng)目工程目錄下生成配置文件
cd test/            #進(jìn)入項(xiàng)目目錄（test為例說明）
Doxygen –g        #生成配置文件
提示：
1、默認(rèn)生成的配置文件名為 "Doxyfile"，也可以指定生成的配置文件名：doxygen -g your-cfg-filename
2、可以在生成配置文件的命令中添加 "-s" 選項(xiàng)，生成不含注釋的配置文件：doxygen -sg
3、根據(jù)需要，修改配置文件
doxygen linux使用方法
一、程序注釋文檔化
使用Doxygen，需要按照Doxygen 的游戲規(guī)則來(lái)對(duì)程序源碼進(jìn)行文檔化。
Doxygen 的注釋類型可分為：
1、行間注釋：注釋語(yǔ)句不與程序源碼出現(xiàn)在同一行，主要用于注釋頭文件中出現(xiàn)的結(jié)構(gòu)體 (struct)、枚舉 (enum)、聯(lián)合 (uion) 等數(shù)據(jù)類型，以及程序接口的功能與使用約定；
2、行內(nèi)注釋：注釋語(yǔ)句與程序源碼出現(xiàn)在同一行內(nèi)，主要用于代碼的局部注釋。
二、文檔生成
cd test/
doxygen
提示：
可以指定配置文件名：doxygen  your-cfg-filename

三、文檔使用
生成的文檔位于test/doc/html 目錄中，使用瀏覽器打開該目錄中的 index.html 文件，即可看到自己的工作成果。

doxygen linux常用選項(xiàng)

# 項(xiàng)目名稱，將作為于所生成的程序文檔首頁(yè)標(biāo)題
PROJECT_NAME        = “Test”
# 文檔版本號(hào)，可對(duì)應(yīng)于項(xiàng)目版本號(hào)，譬如 svn、cvs 所生成的項(xiàng)目版本號(hào)
PROJECT_NUMBER      = "1.0.0
# 程序文檔輸出目錄
OUTPUT_DIRECTORY    =  /home/user1/docs
# 程序文檔輸入目錄
INPUT                = /home/user1/project/kernel
# 程序文檔語(yǔ)言環(huán)境
OUTPUT_LANGUAGE      = Chinese
# 只對(duì)頭文件中的文檔化信息生成程序文檔
FILE_PATTERNS        =
# 遞歸遍歷當(dāng)前目錄的子目錄，尋找被文檔化的程序源文件
RECURSIVE            = YES
# 如果是制作 C 程序文檔，該選項(xiàng)必須設(shè)為 YES，否則默認(rèn)生成 C++ 文檔格式
OPTIMIZE_OUTPUT_FOR_C  = YES
#提取信息，包含類的私有數(shù)據(jù)成員和靜態(tài)成員
EXTRACT_ALL            = yes
EXTRACT_PRIVATE        = yes
EXTRACT_STATIC        = yes
# 對(duì)于使用 typedef 定義的結(jié)構(gòu)體、枚舉、聯(lián)合等數(shù)據(jù)類型，只按照 typedef 定義的類型名進(jìn)行文檔化
TYPEDEF_HIDES_STRUCT  = YES
# 在 C++ 程序文檔中，該值可以設(shè)置為 NO，而在 C 程序文檔中，由于 C 語(yǔ)言沒有所謂的域/名字空間這樣的概念，所以此處設(shè)置為 YES
HIDE_SCOPE_NAMES      = YES
# 讓 doxygen 靜悄悄地為你生成文檔，只有出現(xiàn)警告或錯(cuò)誤時(shí)，才在終端輸出提示信息
QUIET  = YES
# 遞歸遍歷示例程序目錄的子目錄，尋找被文檔化的程序源文件
EXAMPLE_RECURSIVE      = YES
# 允許程序文檔中顯示本文檔化的函數(shù)相互調(diào)用關(guān)系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文檔
GENERATE_LATEX        = NO
# 在程序文檔中允許以圖例形式顯示函數(shù)調(diào)用關(guān)系，前提是你已經(jīng)安裝了 graphviz 軟件包
HAVE_DOT              = YES
CALL_GRAPH            = YES
CALLER_GRAPH          = YES
#在最后生成的文檔中，把所有的源代碼包含在其中
SOURCE BROWSER        = YES
$這會(huì)在HTML文檔中，添加一個(gè)側(cè)邊欄，并以樹狀結(jié)構(gòu)顯示包、類、接口等的關(guān)系
GENERATE TREEVIEW      ＝ ALL

doxygen linux軟件特色

它可以從一組文檔化的源文件生成一個(gè)在線文檔瀏覽器（HTML）和/或離線參考手冊(cè)（$ \ mbox {\ LaTeX} $）。 還支持在RTF（MS-Word），PostScript，超鏈接PDF，壓縮HTML和Unix手冊(cè)頁(yè)中生成輸出。 文檔直接從源中提取，這使得保持文檔與源代碼一致更容易。
您可以配置doxygen從未記錄的源文件中提取代碼結(jié)構(gòu)。 這對(duì)于在大型源代碼中快速找到方法非常有用。 Doxygen還可以通過包括依賴關(guān)系圖，繼承圖和協(xié)作圖來(lái)可視化各種元素之間的關(guān)系，這些都是自動(dòng)生成的。
您也可以使用doxygen創(chuàng)建正常的文檔（就像我對(duì)doxygen用戶手冊(cè)和網(wǎng)站一樣）。