doxygen注釋規范示例（C++）

doxygen能根據code的注釋自動生成code的幫助文檔，并且doxygen是一個跨平臺的開源的軟件，但是要生成幫助文檔，code內的注釋必須按一定規則書寫。下面是我總結的c/c++的注釋書寫規范，代碼風格結合了google c++風格。

/** | 文件注釋* @file apply.c | “@file”后的文件名需與當前文件名一致* @author clover/clover@123.com* @version 1.0* @date 2013-12-12* @brief 概述：doxygen使用文檔* 詳細介紹了doxygen的C++注釋方法* @details 詳細說明* @see MainWindow參考其它的相關的函數，這里作一個鏈接 url* @note 描述需要注意的問題*//// This macro is toolong, so comment here briefly! | 推薦使用簡潔的宏注釋 #define HTTP_REQUEST_LEN_MAX APPLY_BUF_SIZE_BIG /*** The detail macro comment, may be multi-line. | 盡量少寫宏函數，可以使用內聯函數代替* @param a The brief parameter comment* @param b The brief parameter comment* @return The brief return value comment*/ #define MAX(a, b) ((a) > (b))? (a) : (b)/*** @brief 結構體 | 結構體成員的詳細注釋寫在該成員上面* (與名稱后面的描述有一個就可以) | 結構體成員的詳細注釋與上一成員間留1個空行* | 推薦使用簡潔的結構體注釋*/ struct StructVariable { /// @brief 簡單的描述 | “///”與注釋間留有2個空格int a; ///< variable a | “///<”與注釋間留有1個空格int b; ///< variable b/** this is details mement comment */int c; ///< variable cint d; ///< variable d };/** * @enum 性別枚舉*/ enum Sex { /// @enum 性別枚舉kMale, ///< enum malekFemale ///< enum female };/*** @brief 主窗口*/ class MainWindow : public QMainWindow {Q_OBJECTpublic:MainWindow(QWidget *parent = 0);~MainWindow();bool SetProName(QString name); ///< 設置工區名稱private:QString m_name_; };/// @brief 函數名稱：setProName static int ApplyLogin(); /*** @brief 函數名稱：setProName |盡量避免函數聲明和定義重復注釋* @todo 代碼實現的功能: 設置工區名稱* @param 參數：QWidget** @return 說明：int* @retval 1. true 名字設置成功 (返回值說明(可選))* @retval 2. false 名字設置失敗* @bug 此處的bug描述: 無*/ bool MainWindow::SetProName(QString name) { }// 其它注釋// 代碼中其余注釋一律使用普通的單行注釋“//”和多行注釋“/*”“*//* * Doxygen 會忽略你注釋中的換行符，將多行注釋連接成一個連續行并使用空格隔開。* 如果你希望保留兩行注釋之間的換行，需要在該行末加入“/n”。* * 常用命令* @attention 注意* @author 作者* @bug 缺陷，鏈接到所有缺陷匯總的缺陷列表* @brief 簡要注釋* @code 代碼塊開始，與“endcode”成對使用* @endcode 代碼塊結束，與“code”成對使用* @details 詳細注釋* @date 日期* @file < 文件名> 文件參考，用在文件注釋中* @param 參數，用在函數注釋中* @return 返回，用在函數注釋中* @todo TODO，鏈接到所有TODO 匯總的TODO 列表* @version 版本* @warning 警告*/

總結

以上是生活随笔為你收集整理的doxygen注释规范示例（C++）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。