C語言中的Doxygen注釋模板

2021-10-07 20:04:54 字數 2308 閱讀 5675

嵌入式c語言開發中通常使用doxygen進行文件的生成。doxygen支援多種格式,非常靈活,但排版不好就會顯的比較雜亂,不便於閱讀。下面給出乙份注釋模板。

/**

* @file

* @brief this is a brief description.

* @details this is the detail description.

* @author author

* @date date

* @version v1.0

* @par history:

* version: author, date, desc\n

*/

@file 後面貌似不能加檔名,否則不能識別檔案頭;doxygen生成示意圖:

* @retval ok 成功

* @retval error 錯誤

* @par 識別符號

* 保留

* @par 其它

* 無

* @par 修改日誌

* ***於2020-07-06建立

*/int

cstyle

(int inargname,

int outargname)

;doxygen生成示意圖:

/** 

* @brief this is a brief description.

* @details this is the detail description.

*/typedef

struct

abc;

doxygen生成示意圖:

doxygen生成示意圖:

doxygen生成示意圖:

檔案資訊:

1) @file --> 檔案宣告,即當前檔名

2) @author --> 作者

3) @version --> 版本,

4) @todo --> 改進,可以指定針對的版本

模組資訊:

1) @var --> 模組變數說明

2) @typedef --> 模組變數型別說明

函式資訊:

1) @param --> 引數說明

2) @arg --> 列表說明引數資訊

3) @return --> 返回值說明

4) @retval --> 返回值型別說明

5) @note --> 註解

提醒資訊:

1) @brief --> 摘要,即當前檔案說明

2) @see --> 參看

3) @attention --> 注意

4) @bug --> 問題

5) @warning --> 警告

6) @sa --> 參考資料

C 注釋和doxygen注釋

c 的注釋只有兩種 單行注釋,以 開頭 段落注釋,以 開始,以 結束。int value value是乙個整型變數,這是一句單行注釋 test是乙個測試用的類 這是一段注釋中的一行 這是一段注釋中的另一行 class test 參照上文c 注釋的分類方式,doxygen注釋可以這樣劃分 前置單行注釋...

Doxygen的注釋規則

注釋格式 或 或 或 常用關鍵字列表 關鍵字標籤名功能描述 生成乙個黑心圓.指定按順序標記。指定連線函式功能。注 空格和 有連線功能,但建議還是使用 只對函式有用。mainpage 首頁描述內容,並將注釋提到首頁標籤中去 section 開始乙個段落,段落名稱描述由你自己指定 file 檔名,可以預...

C語言的注釋

c語言中,注釋有兩種型別 單行注釋通常用於對程式中的某一行 進行解釋,用 符號表示,後面為注釋的內容 示例 printf hello,world n 輸出hello,world多行注釋就是注釋中的 可以為多行,以符號 開頭,以符號 結尾 示例 printf hello,world n return ...