安裝doxygen 安裝包 doxygen-1.7.4.linux.bin.tar.gz(可在官網下載下傳)
指令:
1) tar xvfz doxygen-1.7.4.linux.bin.tar.gz
2) cd doxygen-1.7.4
3) ./configure
4) make
5) make install
安裝後需留意下doxyg的路徑,例如:/usr/bin/doxygen
配置Doxygen工作環境 步驟:
6) 進入項目目錄(test為例說明) cd test/
7) 生成配置檔案 Doxygen –g
l 預設生成的配置檔案名為 "Doxyfile",也可以采用 "doxygen -g your-cfg-filename" 指令格式指定所生成的配置檔案名。如無特殊需要,采用預設的配置檔案名即可。
l Doxyfile 檔案内容非常多,大概 1000 多行,不過其中約 4/5 都是注釋,每個配置選項都有一段詳細的注釋。日後,如果對 Doxygen 各配置選項的意義有一定了解,可以在生成配置檔案的指令中添加 "-s" 選項,生成不含注釋的配置檔案,操作如下:$ doxygen -s -g
3)配置檔案的相應設定 ,這裡已經有個模闆Doxyfile(test檔案夾下),可以根據需要更改相應設定
項目名稱,将作為于所生成的程式文檔首頁标題
PROJECT_NAME = “Test
文檔版本号,可對應于項目版本号,譬如 svn、cvs 所生成的項目版本号
PROJECT_NUMBER = "1.0.0
程式文檔輸出目錄
OUTPUT_DIRECTORY = doc/
程式文檔語言環境
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 = NO
在程式文檔中允許以圖例形式顯示函數調用關系,前提是你已經安裝了 graphviz 軟體包
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
#讓doxygen從配置檔案所在的檔案夾開始,遞歸地搜尋所有的子目錄及源檔案
RECURSIVE = YES
#在最後生成的文檔中,把所有的源代碼包含在其中
SOURCE BROWSER = YES
$這會在HTML文檔中,添加一個側邊欄,并以樹狀結構顯示包、類、接口等的關系
GENERATE TREEVIEW = ALL
程式源碼文檔化 準備好 Doxygen 的工作環境後,就需要根據 Doxygen 所定義的注釋規則,對程式源碼進行文檔化。換句話說,就是在對程式源碼添加注釋時,要按照 Doxygen 的遊戲規則來搞。
Doxygen 的注釋類型可分為:
l 行間注釋:注釋語句不與程式源碼出現在同一行,主要用于注釋頭檔案中出現的結構體 (struct)、枚舉 (enum)、聯合 (uion) 等資料類型,以及程式接口的功能與使用約定;
l 行内注釋:注釋語句與程式源碼出現在同一行内,主要用于代碼的局部注釋。
注釋的種類有很多,下面是其中的一種:
Doxygen 認可的行間注釋标記見下例:
Doxygen 認可的行内注釋标記見下例:
typedef struct { double coord[3]; /// 這是行内注釋示例
}M2_3D_Point;
程式文檔生成 現在開始生成程式文檔,将終端的工作目錄定位在 test 目錄,然後鍵入:
$ doxygen your-cfg-filename
your-cfg-filename 是 Doxygen 配置檔案名,如果是使用 "doxygen -g" 生成的配置檔案——Doxyfile,那麼可以在終端裡僅鍵入 "doxygen" 指令即可生成程式文檔。
生成的文檔位于 test/doc/html 目錄中,使用浏覽器打開該目錄中的 index.html 檔案,即可看到自己的工作成果。
Doygen 內建到codeBlocks 5.1 配置步驟 在codeBlocks工作界面中,Tools->Configure tools ->Add
Name :doxygen
Executable:/usr/bin/doxygen
Parameters:配置檔案名,(如果doxygen –g 生成的預設配置檔案,在這裡不需要寫)
Working directory:test(要生成程式文檔的項目路徑)
5.2 使用: 當需要生成程式文檔時:Tools->doxygen 即可。生成的文檔位于 test/doc/html 目錄中,使用浏覽器打開該目錄中的 index.html 檔案,即可看到自己的工作成果