1. 安裝和配置

這個(gè)配置好的文件以后可以重復(fù)利用，每次點(diǎn)”Load…”裝載進(jìn)來(lái)，然后點(diǎn)擊”Wizard…”，根據(jù)不同的工程，修改工程名字，版本，源代碼根目錄，文檔輸出目錄就可以了，不用再重復(fù)上述配置。

        注釋寫在對(duì)應(yīng)的函數(shù)或變量前面。
       簡(jiǎn)要注釋和詳細(xì)注釋：
/**
* @brief Brief Description.
*
* Detailed Description
*/
       簡(jiǎn)要注釋和詳細(xì)注釋用一個(gè)空行隔開。
J       avaDoc風(fēng)格下，自動(dòng)會(huì)把第一個(gè)句號(hào)前的文本作為簡(jiǎn)要注釋，后面的為詳細(xì)注釋。你也可以用空行把簡(jiǎn)要注釋和詳細(xì)注釋分開。注意要設(shè)置JAVADOC_AUTOBRIEF設(shè)為YES。
       為了注釋一個(gè)類中的member，首先要對(duì)該類作注 釋。同樣的問(wèn)題上升到namespace。要注釋一個(gè)全局的function，typedef，enum或preprocessor定義，你需要首先定義 （只能用@file，因?yàn)槲募辉偃魏螙|西里面，就只能用特殊命令實(shí)現(xiàn)了，而不像類、函數(shù)等，既可以在上方放注釋，也可以用@class、@fn進(jìn)行注 釋）包含它的文件。

       （1）文件頭注釋
/** @file [file-name]
*@brief brief description.
* @author <list of authors>
* [@author <authors description>]
* @date <date>
* @version <version number>
*
* detailed description for test.cpp
*/
       一般@file后我們空著，Doxygen會(huì)默認(rèn)為是@file所在文件的文件名。
       []表示可選，{}表示重復(fù)0到N次，<>表示必須參數(shù)。@author 表示作者，@data表示日期，@version表示版本號(hào)。
       （2）類注釋
/**
* @class <class-name> [header-file] [<header-name]
* @brief brief description
*
* detailed description
*/
header-file是類聲明所在的頭文件名字，header-name是要顯示的鏈接文字，一般為頭文件的真實(shí)路徑。
       （3）函數(shù)注釋
/**
* @brief brief description.
* {@param <parameter-name> <parameter description>}
* @exception <exception-object> <exception description>
* {@exception <exception-object> <exception description>}
* @return <description of the return value>
* {@return <description of the return value>}
* @note <text>
* @remarks <remark text>
* {@remarks <remark text>}
* [@deprecated <description>]
* [@since when(time or version)]
* [@see references{,references}]
*/
@可用\代替，但我傾向于用@。
@param   參數(shù)名及其解釋（我還習(xí)慣在param后加[IN]表示輸入還是輸出參數(shù)）
@exception 用來(lái)說(shuō)明異常類及拋出條件
@return   對(duì)函數(shù)返回值做解釋
@note   表示注解，暴露給源碼閱讀者的文檔
@remark   表示評(píng)論，暴露給客戶程序員的文檔
@since   表示從那個(gè)版本起開始有了這個(gè)函數(shù)
@deprecated 引起不推薦使用的警告
@see   表示交叉參考
函數(shù)的詳細(xì)注釋用@note代替詳細(xì)注釋，因?yàn)樵敿?xì)注釋要空行隔開，容易忘記。
       （4）成員注釋
/**< 或//<用來(lái)注釋成員，放在成員后面，格式如下：
int var; /**< Detailed description after the member */
int var; ///< Brief description after the member
       此語(yǔ)法對(duì)函數(shù)成員也適用。
       （5）枚舉類型注釋
      /** @brief Another enum, with inline docs */
      enum AnotherEnum
      {
        V1, /**< value 1 */
        V2 /**< value 2 */
      };

一般約定：
       （1）每個(gè).h和.cpp文件的頭部，必須要有簡(jiǎn)要注釋和詳細(xì)注釋，習(xí)慣用法如下：
/** @file
*@brief brief description.
* @author <list of authors>
* @date <date>
* @version <version number>
*
* detailed description for test.cpp
*/
       （2）每個(gè)類的聲明上方，必須要有簡(jiǎn)要注釋和詳細(xì)注釋，習(xí)慣用法如下：
/**
* @class
* @brief brief description
*
* detailed description
*/
       （3）全局變量和全局宏必須要有注釋。
如果注釋較短，則可以在上方用
/** @brief some brief description */或右方用
///< some brief description。
進(jìn)行簡(jiǎn)要注釋。
       （4）任何函數(shù)都必須要有簡(jiǎn)要注釋和詳細(xì)注釋，習(xí)慣用法如下：
/**
* @brief brief description.
* @param <parameter-name> <parameter description>
* @exception <exception-object> <exception description>
* @return <description of the return value>
* @note <text>
* @remarks <remark text>
*/
       對(duì)于類的函數(shù)成員，在頭文件的定義處進(jìn)行簡(jiǎn)要注釋，放在上方：
class Test
{
public:
/** @brief brief description */
int m_test(int a);
}
       而在實(shí)現(xiàn)出給出詳細(xì)注釋：
/**
* @param [IN] a a integer
* @exception none
* @return 0
* @note detailed description
* @remarks some remarks to be attentioned
*/
int Test::m_test(int a)
{
Return 0;
}
       純虛函數(shù)由于沒(méi)有實(shí)現(xiàn)則簡(jiǎn)要注釋和詳細(xì)注釋不需分開。
        對(duì)于類的數(shù)據(jù)成員，只在頭文件的定義處進(jìn)行簡(jiǎn)要注釋，不要詳細(xì)注釋?？梢栽谏戏接?** @brief some brief description */或右方用///< some brief description。
       （5）每個(gè)枚舉定義必須添加注釋,格式如下:
/** Another enum, with inline docs */
enum AnotherEnum
{
V1, //< value 1
V2 //< value 2
};
       下面是一個(gè)簡(jiǎn)單的例子，完全符合約定：
/** @file
* @brief a brief description for the file.
* @author soulmachine
* @date 2008/07/02
* @version 0.1
*
* detailed description for test.cpp
*/

/** @brief global function, no details
* @note some details about global function
*/
void global_test();

/** @class Test test.h "inc/test.h"
* @brief A test class.
*
* A more elaborate class description.
*/

class Test
{
public:

/** @brief A enum, with inline docs */
enum TEnum {
   TVal1, /**< enum value TVal1. */
   TVal2, /**< enum value TVal2. */
   TVal3 /**< enum value TVal3. */
}
//這里Doxygen對(duì)enumPtr的處理有點(diǎn)問(wèn)題
*enumPtr, ///< enum pointer.
   enumVar; ///< enum variable.

/** @brief A constructor. */
Test();

/** @brief A destructor. */
~Test();

/** @brief a normal member taking two arguments and returning an integer value. */
int testMe(int a,const char *s);

/** @brief A pure virtual member.
* @param c1 [IN] the first argument.
* @param c2 [IN] the second argument.
* @see testMe()
*/
virtual void testMeToo(char c1,char c2) = 0;

int publicVar;//< a public variable.

/** @brief a function variable, note Details. */
int (*handler)(int a,int b);

/** @brief brief before delaration */
int m_func(int a);
};

/** A more elaborate description of the constructor. */
Test::Test()
{
}

/** A more elaborate description of the destructor. */
Test::~Test()
{
}

/**
* @param [IN] a an integer argument.
* @param [IN] s a constant character pointer.
* @return The test results
* @note Details.
* @par
* Another detail.
* @see Test()
* @see ~Test()
* @see testMeToo()
* @see publicVar()
*/
int Test::testMe(int a,const char *s)
{
return 0;
}

/**
* @param [IN] a a interger
* @return 0
* @note detailed description
* @remarks remarks,important
* @since 1.0
* @see testMeToo
*/

int Test::m_func(int a)
{
return 0;
}

百度博客限制文章長(zhǎng)度，郁悶死了，每次先從word粘到記事本，在粘到編輯器，然后調(diào)格式，太痛苦了。下面是PDF版本，不斷更新中......