來(lái)源：
http://www.vckbase.com/document/viewdoc/?id=1287作者：
hjs下載Doxygen相關(guān)文件
Doxygen 是一個(gè)類似 JavaDoc 的文檔生成工具。有了它，C++愛(ài)好者就可以為自己的源代碼很方便地生成美觀實(shí)用的文檔了。
為代碼生成文檔標(biāo)注基礎(chǔ)
您可以使用JavaDoc風(fēng)格，類似于由C風(fēng)格的注釋塊：
/**
* ... 文本 ...
*/
此外您也可以使用Qt風(fēng)格，如
/*!
* ... 文本...
*/
以上兩種風(fēng)格中間的*是可選的，也就是下面這樣寫也是可以的：
/*!
... 文本...
*/
第三種是使用至少兩行C++"http://"注釋，如：
///
/// ... 文本...
///
或者
//!
//!...文本...
//!
有的程序員也許喜歡下面這種風(fēng)格，有比較好的視覺(jué)效果：
/////////////////////////////////////////////////
/// ... 文本...
/////////////////////////////////////////////////
對(duì)于簡(jiǎn)單的描述信息，可能有幾種情況。一種是在注釋塊的開頭使用\brief命令，該命令一直到段落結(jié)束有效，所以詳細(xì)描述信息從空一行后開始，如下例：
/*! \brief 簡(jiǎn)潔的描述信息 description.
* 又一些簡(jiǎn)潔的描述信息。
*
* 詳細(xì)描述信息從這里開始。
*/
在配置文件中，如果JAVADOC_AUTOBRIEF設(shè)為YES，則Doxygen將使用JavaDoc風(fēng)格的注釋塊，從簡(jiǎn)潔描述信息后的點(diǎn)空格. 開始為詳細(xì)描述信息，例如：
/** 簡(jiǎn)潔信息結(jié)尾是一個(gè)點(diǎn)號(hào). 詳細(xì)描述信息從
* 這里開始
*/
該選項(xiàng)對(duì)C++風(fēng)格的多行注釋也是有效的：
///簡(jiǎn)潔信息結(jié)尾是一個(gè)點(diǎn)號(hào). 詳細(xì)描述信息從
///這里開始
或者：
/// 簡(jiǎn)潔描述信息
/** 詳細(xì)描述信息*/
或者：
//!簡(jiǎn)潔描述信息
//!詳細(xì)描述信息從
//!這里開始
此例中間空行用來(lái)分割簡(jiǎn)潔描述信息塊和詳細(xì)描述信息塊。可見doxygen的文檔標(biāo)注使用格式是非常自由的。不過(guò)要注意下面格式是不合法的，因?yàn)閐oxygen只允許一塊詳細(xì)描述信息對(duì)應(yīng)一塊簡(jiǎn)潔描述信息：
//!簡(jiǎn)潔描述信息
//! 詳細(xì)描述信息
/*! 注意，又一詳細(xì)描述信息!
*/
下例使用Qt風(fēng)格的文檔標(biāo)注：
//! A test class.
/*!
A more elaborate class description.
*/
class Test
{
public:
//! An enum.
/*! More detailed enum description. */
enum TEnum {
TVal1, /*!< Enum value TVal1. */
TVal2, /*!< Enum value TVal2. */
TVal3 /*!< Enum value TVal3. */
}
//! Enum pointer.
/*! Details. */
*enumPtr,
//! Enum variable.
/*! Details. */
enumVar;
//! A constructor.
/*!
A more elaborate description of the constructor.
*/
Test();
//! A destructor.
/*!
A more elaborate description of the destructor.
*/
~Test();
//! A normal member taking two arguments and returning an integer value.
/*!
\param a an integer argument.
\param s a constant character pointer.
\return The test results
\sa Test(), ~Test(), testMeToo() and publicVar()
*/
int testMe(int a,const char *s);
//! A pure virtual member.
/*!
\sa testMe()
\param c1 the first argument.
\param c2 the second argument.
*/
virtual void testMeToo(char c1,char c2) = 0;
//! A public variable.
/*!
Details.
*/
int publicVar;
//! A function variable.
/*!
Details.
*/
int (*handler)(int a,int b);
};
Doxygen的文檔標(biāo)注是不是非常容易？當(dāng)然還可以有更高級(jí)的應(yīng)用，如標(biāo)注列表、分組，甚至支持生成公式(Latex)。上面只編譯了最簡(jiǎn)單的一些使用方法，更多內(nèi)容請(qǐng)參考Doxygen的幫助文檔doxygen_manual。
附帶文檔的說(shuō)明：
DoxygWizard是基于QT的簡(jiǎn)易圖形用戶界面，簡(jiǎn)化了Doxygen的使用。您可以在DoxygWizard里對(duì)需要生成的文檔進(jìn)行設(shè)置，可保存為"Doxyfile"，然后調(diào)用Doxygen生成文檔。需要注意的是，文件路徑不支持中文，所以盡可能使您的源代碼和文檔目錄均為英文名。在"Doxyfile"文件同一目錄請(qǐng)放置一個(gè)"mylogo"純文本文件，內(nèi)容可以是一些版權(quán)標(biāo)識(shí)信息，這些信息將顯示在生成文檔頁(yè)面的最下邊，如果沒(méi)有此"mylogo"文件，將生成默認(rèn)的版權(quán)標(biāo)識(shí)信息。
樣式表文件Orignl_doxygen.css、green_doxygen.css、yellow_doxygen.css、Blue_doxygen.css，改文件名為doxygen.css后，拷貝到生成html文檔的目錄內(nèi)可以改變文檔顯示的樣式。
OUT PUT_LANGUAGE 可選項(xiàng)為Englisth(英文文檔), Chinese(中文文檔), En_Can_Cn(支持中文注釋的英文文檔)
相關(guān)網(wǎng)址：
http://www.doxygen.org/download.html
您還需要下載graphviz dot畫圖：
http://www.research.att.com/sw/tools/graphviz/