注釋格式
/**……*/
或
/*!…
*/或
/// …
或
//!//! …
//!常用關鍵字列表
關鍵字標籤名功能描述
-生成乙個黑心圓.
-#指定按順序標記。
::指定連線函式功能。（注：空格和「:」有連線功能,但建議還是使用」::」。只對函式有用。）
@mainpage
首頁描述內容，並將注釋提到首頁標籤中去
@section
開始乙個段落，段落名稱描述由你自己指定
@file
檔名，可以預設為空，doxygen會自己加
@brief
概要資訊,簡短描述，自動列在注釋前。
@name
自定義名
分組名強制給注釋段給定自定義名稱，自動列在注釋前，比@brief還前。
@author
作者@version
版本@date
日期@note
註解@attention
注意@warning
警告@exception
異常可能產生的異常描述 eg: @exception 本函式執行可能會產生超出範圍的異常
@post
後置條件
用來說明**項之後的使用條件。
@remarks
備註@par
自定義名
開始乙個段落，段落名稱描述由你自己指定
@param
引數主要用於函式說明中，後面接引數的名字，然後再接關於該引數的說明
@return
返回描述該函式的返回值情況eg: @return 本函式返回執行結果，若成功則返回true，否則返回flase
@retval
返回值描述返回值型別 eg: @retval null 空字串。@retval !null 非空字串
@var
變數引出了某個變數，doxygen會在該變數處產生乙個鏈結，歸納到變數列表中去。
@enum
列舉引出了某個列舉，doxygen會在該列舉處產生乙個鏈結，歸納到列舉列表中去。
@struct
結構體引出了某個結構體，doxygen會在該列舉處產生乙個鏈結，歸納到結構體列表中去。
@class
類引用某個類，格式：@class eg:@class ctest 「inc/class.h」
@code
在注釋中開始說明一段**，直到@endcode命令。
@endcode
在注釋中**段的結束。
@defgroup
自定義模組名
@addtogroup
自定義模組名
新增到乙個組。模組
@ingroup
自定義模組名
加入到乙個組 模組
@模組結束
@see
參見一段包含其他部分引用的注釋，中間包含對其他**項的識別符號，自動產生對其識別符號的鏈結。
@since
自從從哪個版本後開始有這個函式的，通常用來說明從什麼版本、時間寫此部分**。
@bug
bug：
被標記的**會鏈結到 bug列表
@todo
待辦事項：
對將要做的事情進行注釋，鏈結到 待辦事項列表
@deprecated
棄用：這個函式可能會在將來的版本中取消，鏈結到 待辦事項列表
Doxygen注釋命令
1 輸出 dstatus value instruction sta noinit 0x01 drive not initialized sta nodisk 0x02 no medium in the drive sta protect 0x04 write protected 效果為 4 以黑體...
C 注釋和doxygen注釋
c 的注釋只有兩種 單行注釋，以 開頭 段落注釋，以 開始，以 結束。int value value是乙個整型變數，這是一句單行注釋 test是乙個測試用的類 這是一段注釋中的一行 這是一段注釋中的另一行 class test 參照上文c 注釋的分類方式，doxygen注釋可以這樣劃分 前置單行注釋...
C語言中的Doxygen注釋模板
嵌入式c語言開發中通常使用doxygen進行文件的生成。doxygen支援多種格式，非常靈活，但排版不好就會顯的比較雜亂，不便於閱讀。下面給出乙份注釋模板。file brief this is a brief description.details this is the detail descri...