1.前言

為了增強原始碼的可閱讀性、結構性，方便程式碼閱讀者對原始碼的閱讀和理解，以及方便原始碼文件的製作和生成，原始碼的註釋通常按一定的規範編寫。
所以要想更好的讀懂原始碼，就必須對註釋規範有一定的瞭解。

2.註釋詳解

2.1 定義註釋塊

/*!
 * 一個註釋塊
 */

2.2 檔案註釋塊

/*!
 * @file 檔名
 * @brief 檔案簡要說明
 * @author 作者
 * @date 時間
 * @version 版本
 */

2.3 類註釋塊

/*!

 * @class 類名
 * @brief 類簡要說明
 * 
 * 詳細描述
 */

2.4 類成員方法、數註釋標記

• 簡要說明標記（@brief），內容為方法 / 函式的簡要說明。
• 詳細描述，詳細描述與@brief標記之間空一行
• 若干個引數描述標記（@param），數量與該方法的輸入引數個數相同。格式為：“@param 引數名稱 引數說明”。
• 異常描述標記（@exception），對該方法丟擲的異常進行描述，可省略。
• 警告標記（@warning），對呼叫方法需要注意的地方進行描述，可省略
• 前置條件標記（@pre），描述執行方法的前置條件，比如對輸入引數的要求等，可省略。
• 後置條件標記（@post），描述執行方法的後置條件，比如對系統狀態的影響或返回引數的結果預期等，可省略。
• 增加日期標記（@since），對於新增的方法，描述什麼時候增加該方法及增加該方法的意圖。可省略
• TODO標記（@todo），對該方法將要做的事情進行描述，用於比較關鍵的方法。
• 缺陷標記（@bug），對該方法存在的缺陷進行描述。若存在已知的缺陷，需要定義該標記，否則省略
• 返回值標記（@return），描述該方法的返回值，格式為：“@return 返回值型別 返回值描述”。若返回值為void型別，則省略該標記

2.5 模組註釋

/*！
 * @defgroup 模組名稱
 * @brief 模組簡介
 *
 * 模組的詳細描述
 * @{
 */





/** @} */

@{ 是模組起始標記。
/* @} /是模組結束標記。
位於模組起始註釋塊與結束註釋塊之間的所有內容將歸入該模組。