doxygen上手
doxygen {#mainpage}
doxygen是幹什麼的
相信大家在看MCU原廠的幫助文檔的時候，都能看到doxygen的logo在右下角，沒錯，doxygen就是用來生成幫助文檔的
doxygen可以根據代碼中的注釋信息，來生成代碼的一個幫助文檔
軟件安裝
doxygen安裝
- 上doxygen官網下載
-
安裝，安裝就很簡單，一路next就完事了
-
安裝完發現並沒有生成桌面快捷方式，但是可以在windos的start或者安裝目錄找到，來一波添加桌面快捷方式
HTML Help (CHM) Help Compiler 安裝
- HHC是用來生成CHM文件的，所以也會用到
去官網下載
下載doxygen中文手冊
我從網上找到了這個doxygen的中文手冊,給放在我的gitee上了，對於我這個英文不是很好的人來說，這個資料算是格外的珍貴了，也給大家分享一下
doxygen GUI frontend的使用
下面我都是使用這個GUI的程序來進行的
需要注意的地方
Expert->Input
注意，需要吧用到的資源的所有文件夾都包含進去，不然生成CHM可能會缺失
其他的就參見gitee上的工程文件吧
代碼添加註釋(VSCode korofileheader插件)
"fileheader.customMade":{
"file":"",
"Author": "chenjk",
"Date": "Do not edit",
"LastEditTime": "Do not edit",
"FilePath": "Do not edit",
"Description": "",
},
"fileheader.cursorMode": {
"brief":"",
"param":"",
"return":"",
},
"fileheader.configObj": {
"createHeader": true, //默認打開
"colon":" ",
"annotationStr": {
"head": "/**", // 自定義注釋頭部
"middle": " * @", // 自定義注釋中間部分(注意空格,這也是最終生成注釋的一部分)
"end": " */", // 自定義注釋尾部
"use": false // 是否使用自定義注釋符號
}
}
安裝完之後，使用CTRL+ALT+I可以向代碼中添加文件頭部信息，使用CTRL+ALT+T可以添加函數注釋格式信息，但因為我電腦的CTRL+ALT+T快捷鍵衝突了，我只能改建成CTRL+ALT+U，改鍵方法如下
注釋
doxygen會識別如下如下格式的內容為用戶需要doxygen進行抽取的
/** * */
其中第一行的第二個*即提示doxygen此處有需要抽取的注釋，否則doxygen並不會進行檢查
@或者\符號是命令的提示符
比如命令brief為描述，在其前面添加@doxygen就會識別到這個命令，同理param也需要在前面加上@符號
常見的注釋格式為:
建議在其中這個注釋可以放在.c文件也可以放在.h文件，建議是如果存在.c文件，那麼放在.c中，否則放在.h文件中。
另外如果兩個都有，建議.h放簡單的描述和輸入輸出的參數說明，若有更複雜的Note、Waring、details等，放在.c文件中
特殊命令
addtogroup
是將API分門別類的好工具，具體的效果就是會在生成的chm或HTML中增加一個模塊頁面增加這個組，這個組中會列舉組中API的函數、枚舉、定義等內容，所以如果需要代碼API需要按模塊來分類，並且可以配合brief來對模塊進行說明，這是個利器
mainpage命令
我們可以使用md文件來製作首頁，其方法就是在一級標題後面添加 {#mainpage},並且把這個文件添加到input中去
Note:
1. 但注意這個一定要是在md文件的最開頭,並且前面沒有東西
