安裝Doxygen
sudo apt-get install doxygen安裝Graphviz
sudo apt-get install graphvizdoxygen -g
或者，doxygen –s –g （simple，generate）
使用上述命令在當(dāng)前目錄下生成名為Doxygen的配置文件模板；默認(rèn)生成的配置文件名為 Doxyfile
1）在配置文件中修改PROJECT_NAME; PROJECT_NUMBER;
OUTPUT_DIRECTORY(輸出文檔的目錄臊诊，如果為空憎茂，表示在當(dāng)前目錄)语御； OUTPUT_LANGUAGE（可以指定為Chinese）磅崭；IMAGE_PATH = image_dir（指定圖片存放的目錄，將圖片放到當(dāng)前目錄下的image_dir）
INPUT =xxx郑原，代碼文件或目錄，多個(gè)文件(目錄)需要以空格隔開(kāi)夜涕，如果不指定犯犁，表示當(dāng)前目錄；如果指定目錄且當(dāng)前目錄有代碼文件的話女器，需要用(.)表示當(dāng)前目錄
FILE_PATTERNS = *.cpp *.h
doxygen Doxyfile //可以生成一個(gè)文檔
- c系語(yǔ)言中的注釋塊
1）詳細(xì)注釋
///
/// ... text ...
///
或者
/**
- ... text ...
/ 等方式酸役。。驾胆。
如果想讓注釋塊更可見(jiàn)簇捍，可用下面方式：
/*********************************//* - ... text
*************************************/
或者
//////////////////////////////////////////////////////
/// ... text ...
/////////////////////////////////////////////////////
2）簡(jiǎn)單注釋
/// Brief description.
- 文本放在成員后面
當(dāng)要給文件的成員，結(jié)構(gòu)體俏拱，類暑塑，枚舉添加文本，需要將文本塊放到成員后面锅必。加上<在評(píng)論塊中事格，這同樣可以作用于函數(shù)的參數(shù)
int var; ///< detailed description after the member
對(duì)于函數(shù)要使用[in,out]
void foo(int v /*< [in] docs for input parameter v. /);
以上4-5只可以用于注釋成員（members）和參數(shù)（parameters）
%%%
變量注釋
/// 簡(jiǎn)述
/ 詳細(xì)描述 */ - Doxygen中需要改的地方
1）DOXYFILE_ENCODING = UTF-8
2）PROJECT_NAME 項(xiàng)目名稱
3）PROJECT_NUMBER 項(xiàng)目版本號(hào)
4）OUTPUT_DIRECTORY 輸出文檔的目錄，建議寫上表示本工程的有意義的目錄名稱
5）OUTPUT_LANGUAGE = English搞隐，文檔語(yǔ)言驹愚，可以指定為Chinese
6）IMAGE_PATH = image_dir，指定圖片存放的目錄劣纲，我們將圖片放到當(dāng)前目錄下的image_dir目錄中逢捺，因?yàn)槲覀兊奈臋n會(huì)出現(xiàn)測(cè)試圖片示例
7）HTML_OUTPUT= . ，html輸出目錄名稱癞季，默認(rèn)為html目錄劫瞳，如果為“.”則表明為上述OUTPUT_DIRECTORY目錄
8）INPUT =xxx，代碼文件或目錄绷柒，多個(gè)文件(目錄)需要以空格隔開(kāi)志于，如果不指定，表示當(dāng)前目錄废睦，但是伺绽，如果指定目錄且當(dāng)前目錄有代碼文件的話，需要使用點(diǎn)號(hào)(“.”)表示當(dāng)前目錄
9）FILE_PATTERNS=xxx，指定各種文件奈应，我們常用為*.cpp *.c *.h澜掩，等等 - \class 注釋類
\struct \union \enum \fn注釋函數(shù) \var 變量或者類型或者枚舉值 \def 注釋#define \typedef document a type definition \file 注釋一個(gè)文件 \namespace 注釋命名空間 \package 注釋java程序包 \interface 注釋一個(gè)IDL界面
%%配置選項(xiàng)參考連接
http://blog.51cto.com/ticktick/188672
