Doxygen C++注釋規范
一、 C++風格的注釋
1 概述
C++的注釋風格主要使用下面這種樣式：即在注釋塊開始使用三個反斜杠‘/’
其他地方其實與javaDoc的風格類似，只是C++風格不用 “*” 罷了。
2 簡述與詳述
C++風格的簡述與詳述方式與javaDoc類似。一般注釋的描述由簡述開始，經過特殊分隔方式后，后面緊跟詳述的內容，C++風格可以使用的分隔方法有以下兩種：
（1）使用 /brief 參數標識，空行作為簡述和詳述的間隔標識
/// /brief Brief description.
/// description continued.
///
/// Detailed description starts here.
///
（2） 使用以空行（或者小數點加空格）作為簡述與詳述的分割
/// Briefdescription
/// description continued.
///
/// Detaileddescription starts here.
以小數點加空格作為分隔如下：
/// Brief description
/// description continued . （注意:這里有一個小數點,加上一個空格）
/// Detailed description starts here.
///
3 注釋風格約定
1.一個代碼塊（類、函數、結構等）的概述采用單行的”///”加一個空格開頭的注釋，并寫在該代碼塊聲明的前面； 2.一個代碼塊的詳述采用至少兩行的”///”加一個空格開頭的注釋，若不足兩行第二行的開頭也要寫出來，并且放在代碼塊定義的前面；如果某代碼沒有聲明只有定義或者相反，則在定義或者聲明前面寫上單行的概述+一個空行+多行的詳述； 3.枚舉值列表的各項、結構域的各項等采用在本行最后添加”///<”加一個空格開頭的注釋； 4.對變量的定義采用在變量上面加單行”///”加一個空格開頭的注釋（相當于是給改變量一個概述）； 5.函數的參數用”/// @param”+一個空格開頭的行描述在函數的詳述里面； 6.函數的返回值用”/// @return”+一個空格開頭的行描述在函數的詳述里面； 7.函數之間的參考用”/// @see”+一個空格開頭的行描述在函數的詳述里面； 8.文件頭的版權以及文件描述的注釋參見例代碼。
4 文件頭注釋示例 //////////////////////////////////////////////////////////////////////////
/// COPYRIGHT NOTICE
/// Copyright (c) 2009,華中科技大學 （版權聲明）
/// All rights reserved.
///
///@file （本文件的文件名eg：Test.h）
/// @brief （本文件實現的功能的簡述）
///
///（本文件實現的功能的詳述）
///
/// @version1.1 （版本聲明）
///@author （作者，eg：盧?。?nbsp;
///@date （文件創建日期，eg：2009年7月15日）
///
///
/// 修訂說明：最初版本
//////////////////////////////////////////////////////////////////////////
5 類定義注釋示例
/// 本類的功能：打印錯誤信息
///
/// 本類是一個單件
/// 在程序中需要進行錯誤信息打印的地方
class CPRintError
{
……
}
6 類成員變量定義示例
（1）在成員變量上面加注釋的格式
///成員變量描述
int m_Var;
（2）在成員變量后面加注釋的格式
int m_color; ///顏色變量
7 成員函數的注釋示例
/// 下面是一個含有兩個參數的函數的注釋說明（簡述）
///
/// 這里寫該函數的詳述信息
/// @param a被測試的變量（param描述參數）
/// @param s指向描述測試信息的字符串
/// @return 測試結果（return描述返回值）
/// @see Test() （本函數參考其它的相關的函數，這里作一個鏈接）
/// @note (note描述需要注意的問題)
int testMe(int a,constchar *s);
8 枚舉變量的注釋示例
/// 顏色的枚舉定義
///
/// 該枚舉定義了系統中需要用到的顏色/n
/// 可以使用該枚舉作為系統中顏色的標識
enumTEnum
{
RED, ///<枚舉，標識紅色
BLUE, ///<枚舉，標志藍色
YELLOW ///<枚舉，標志黃色.
}enumVar;
9 需要注意的問題
（1）Doxygen會忽略你在注釋中加入的多余的換行，如果你希望保留兩行注釋之間的空行，那么，在該行加入 /n
