doxygen 使用 + C/C++註釋規範

1、安裝

yum -y install doxygen  #基本安裝
yum -y install doxygen-doxywizard  #圖形介面安裝

2、生成配置檔案

doxygen -g [配置檔名]  #預設檔名為Doxyfile

3、配置檔案

好多選項呀，1500行，懶得看 –，這個是一個巨大的工作量。
大部分預設，需要改的是輸入/輸出檔案的位置、格式，要輸出那些內容。
其實最懶的方法是用圖形介面配置~ ~f

4、C註釋規範

4.1 註釋風格

• 風格1，預設風格

/*！ \brief 簡要描述
 *
 * 詳細描述
 */
 

• 風格2，QT風格

//! 簡要描述
/*!
 * 詳細描述
 */

• 風格3，JavaDoc風格

/** 簡要描述 . 詳細描述（以'.'作為分隔符）
 *
 */

注：個人喜歡風格2，QT風格~~，不同風格之間也可靈活組合，JavaDOC風格需要修改配置檔案裡的一個選項，不喜。。。

• 類、結構的成員描述

int a; /*!< 內容 */

4.2 不同種類的標籤

標籤中的\可替換成@，個人喜歡\，然感覺@更清晰一點點
* \author 作者
* \brief 摘要
* \version 版本號
* \date 日期
* \file 檔案
* \class 類
* \struct 結構
* \param 函式引數
* \return 函式返回值
* \exception 函式拋異常
* \warning 函式使用需要注意的地方
* \remarks 備註
* \see see also欄位
* \note 詳細描述，摘要後可用note而不用空行表示
* \par 開始一個段落，段落名自定義，如寫一段示例程式碼
* \code 引用程式碼段
* \endcode 程式碼段結束
* \pre 函式前置條件，如對引數的要求
* \post 函式後置條件，如對系統狀態的影響、返回值的預期
以下是不太常用的。。
* \defgroup 模組名
* \name 分組名
* \{ 模組開始
* \} 模組結束
* \since 那個版本後開始有這個函式
* \todo 標記程式碼會在todo列表中出現
* \bug 標記程式碼會在test列表中出現
* - 一級專案符號
* -# 二級專案符號

4.2 例子模板

• 檔案

//! 摘要
/*!
\file       檔名
\author     作者
\version    版本
\date       日期
\note       註解（我把這個當詳細描述用的--）  \n
              '\n' 可以換行 ~~!
*/