下麵是我個人認為比較常用的標記:
@author 作者
@brief 摘要
@version 版本號
@date 日期
@file 文件名,可以默認為空,DoxyGen會自己加
@class 類名
@param 函數參數
@return 函數返回值描述
@exception 函數拋異常描述
@warning 函數使用中需要注意的地方
@remarks 備注
@see see also字段
@note brief下空一行後的內容表示詳細描述,但也可以不空行用note表示
@par 開始一個段落,段落名稱描述由你自己指定,比如可以寫一段示例代碼
@code 引用代碼段
@endcode 引用代碼段結束
@pre 函數前置條件,比如對輸入參數的要求
@post 函數後置條件,比如對係統狀態的影響或返回參數的結果預期
附帶我感覺不太會常用到的其他標記:
@defgroup 模塊名
@name 分組名
@{ 模塊開始
@} 模塊結束
@deprecated 今後可能將被廢棄或已經有替代品的函數
@since 從哪個版本後開始有這個函數的
@todo 被標記的代碼會在ToDo列表中出現
@bug 被標記的代碼會在Bug列表中出現
@test 被標記的代碼會在Test列表中出現
- 一級項目符號
-# 二級項目符號