Doxygen常見註釋格式，供參考
阿新 • • 發佈：2019-02-15
前陣子整理了下Doxygen常見的註釋格式，主要有：檔案註釋、函式註釋等。希望對大家有幫助。
-
1. 檔案註釋
/**************************************************************************/
/**
* @brief 對於檔案的簡單註釋
* @details 對於檔案的詳細註釋
* @addtogroup example 範例
* @author Alex.shi
* @version 0.01
* @date 2010/05/25
******************************************************************************
* Copyright (c), 2010, Alex Co., Ltd.
******************************************************************************
* Edit History /n
* -------------------------------------------------------------------------/n
* DATE NAME DESCRIPTION /n
* 2010/05/25 Alex.shi Create./n
******************************************************************************
* @{
*****************************************************************************/
……………… // 原始碼內容
……………… // 原始碼內容
/** @}***********************************************************/
注意：上面的幾處 ”/n” 是必須的，否則顯示出來將會把那幾行擠到一行中。
2. 函式註釋
/**
* 設定日期的視訊記憶體
* @param[in] beginPos 對應區域開始顯示的地址
* @param[in] order order>0: year/month/date;order=0: date/month/year
* @param[in] linkChar 日期間的連線符, 目前僅支援 '*''#''-''_''='
* @param[in] year 1-9999
* @param[in] month 1-12
* @param[in] day 1-31
* @return 操作結果, 見 ERR_LED_E
* @note 只有在呼叫 LED_Update 後才起效
* @see ::LED_Update ::LED_SetSerialBuf ::LED_SetCharBuf
* @see ::LED_SetTimeBuf ::LED_SetMoneyBuf ::LED_ClearAreaBuf
*/
PUBLIC ERR_LED_E LED_SetDateBuf(uint8 beginPos, uint8 order, uint8 linkChar,
uint16 year, uint8 month, uint8 day)
說明：
@param：註釋輸入/輸出引數；
@return：返回值
@see：參考內容，若 LED_Update() 函式存在的話，將會在文件中顯示為 LED_Update的連結。
@note：顯示注意事項
3. 普通註釋
/** 區域型別 */
typedef enum
{
LED_AREA_NULL = 0, /**< 區域頭 */
LED_AREA_SERIAL_NO, /**< 序號區域 */
LED_AREA_TEXT, /**< 文字區域 */
LED_AREA_TIME, /**< 時間區域 */
LED_AREA_MONEY, /**< 金額區域 */
LED_AREA_UNDEFINE /**< 區域尾 */
}LED_AREA_E;
說明：
/** 註釋內容 */ ：對該註釋後面的內容（如列舉型別、變數等）進行註釋；
/**< 區域頭 */ ：對該註釋前面的內容（如列舉型別、變數等）進行註釋；
4. 塊定義
塊定義主要是將相關的一些變數、函式等資訊統一在一起顯示，並給他們取個名字。如底下的例子，將程式涉及到的幾種圖示用巨集定義出來，並放在一起，起名為“各種圖示定義”。
/****************************************************************/
/**
* @name 各種圖示定義
* @{
*/
/** 鎖圖示 */
#define LED_ICON_LOCK 0x0001
/** 日圖示 */
#define LED_ICON_DAY 0x0002
/** 月圖示 */
#define LED_ICON_MONTH 0x0004
……
/** @}各種圖示定義**************************************************
目前用的比較多的也就是這幾種註釋格式了，以後有碰到其他的再續。