编程的修养 - Doxygen的使用

1、安装和入门

AXin带你学Doxygen 生成文档超简单！_哔哩哔哩_bilibili

2、MDK中创建Doxygen注释模版

C语言 - KEIL / IAR 环境下 Doxygen 使用_doxygen keil-优快云博客

要使用模板功能，十分容易，在Keil中编辑状态下，如果Keil的视图和布局没有改变1，右边应该是工程文件的浏览界面。这个界面的右下角，可以点选模板（Template，图中第四个）栏：

就可以看到很多常用的C语言的一些程序结构，点击任意一个，就能在当前光标处插入对应的模板。

修改模板

Keil自带的模板大多都没有注释，如果要生成带注释版本的模板，就要自己修改或者添加新的模板。方法如下：

点选Edit菜单中的Configuration项；

即可在Configuration窗口里的Text Compilation栏，修改，增添或者删除模板了，添加符合Doxygen规范的注释即可。

例如比较常用的函数模板（void），一个符合Doxygen规范的模板是：

/**
* @brief a short description of what the function does
* @param the first input value
* @return the return value

* @details a full description of what the function does
* @see a reference to another function
*/
void |(){
}

其中的”|“是模板生成后光标所在位置，上面的例子中生成模板后光标会在函数名处，可以直接输入新的函数名。

3、在MDK中使用Doxygen（建议直接用Doxygen UI）

https://www.cnblogs.com/yqmcu/p/11498081.html

4、使用Doxygen生成chm

如何用Doxgen制作chm格式文档-腾讯云开发者社区-腾讯云

hhc.exe下载地址：

https://code.google.com/archive/p/chmwriter/downloads