0、前言
參考帖子。
使用Doxygen Documentation Generator自動添加注釋
Doxygen使用教程
代碼注釋規范之Doxygen
1、Doxygen介紹
Doxygen 是一個功能強大的開源文檔生成工具，主要用于從源代碼中自動提取注釋并生成專業的 API 文檔。它支持多種編程語言（C、C++、Java、Python、Objective-C 等），廣泛應用于軟件開發、庫開發和技術文檔編寫。
- 自動提取代碼注釋
- 生成多種格式的文檔
- 生成類圖和依賴關系
- 自動生成文檔結構組織
- 條件編譯文檔（通過 \if、\else、\endif 為不同平臺或配置生成不同文檔）
2、Doxygen常用注釋命令
@project與\project等效，其它注釋命令也是一樣的道理。
| 注釋命令 | 含義 |
|---|---|
| @project | 描述項目 |
| @file | 描述文件 |
| @author | 作者信息 |
| @version | 描述版本 |
| @date | 描述時間 |
| @copyright | 描述權限 |
| @attention | 注意事項 |
| @brief | 概要信息 |
| @example | 使用示例 |
| @ wanrning{warning message} | 一些需要注意的事情 |
| @ todo{things to be done} | 即將要做的事情，會鏈接到todo列表 |
| @ bug | 有缺陷的地方，會鏈接到bug列表 |
| @see | 引用其它文檔或項目 |
| @code···@endcode | 注釋中說明某一代碼段 |
| @deprecated | 廢棄的函數 |
| @note | 開始一個段落，用來描述一些注意事項 |
| @param | 標注一個參數的意義 |
| @return | 描述一個返回的意義 |
| @include | 標注包含文件 |
| @var | 描述變量 |
| @enum | 描述枚舉 |
| @struct | 描述結構體 |
| @clas | 描述類 |
3、如何在VSCode中使用Doxygen
Doxygen有專門的工具，不過我目前是在vscode中安裝Doxygen Documentation Generator，暫時只需要快速生成規范性注釋。若需要生成文檔或圖表，就需要使用Doxygen工具了。
4、如何進行自定義規范
可以在setting.json文件中配置，或setting界面配置相關參數，主要配置的就是觸發快捷鍵、作者、郵箱等。也可以在setting.json中配置自定義分格的注釋。
下面貼上自己配置的注釋風格。（注意，自定義的風格里面，有顯示內容限制，可以參考setting界面的說明）
"doxdocgen.generic.authorEmail": "xxx@163.com","doxdocgen.generic.authorName": "xxx","doxdocgen.file.copyrightTag": ["@copyright Copyright (c) {year} , All Rights Reserved. ",],"doxdocgen.file.customTag": ["**********************************************************************",],"doxdocgen.file.fileOrder": ["custom","file","author","version","date","brief","copyright", "empty", "custom" ],"doxdocgen.generic.customTags": ["**********************************************************************",],"doxdocgen.generic.order": ["custom","brief","param","return","custom",],"doxdocgen.generic.paramTemplate": "@param {param} comment ","doxdocgen.generic.returnTemplate": "@return {type} comment",// 觸發快捷鍵"doxdocgen.c.triggerSequence": "///",
效果如下。
