doxygen的使用配置并生成文档

Posted 2020-08-14 飞翔雨feixy的博客

原创文章，欢迎阅读，禁止转载。

doxygen是个好用的文档生成工具，他的强大功能有很多介绍，我就不说了。
自带的chm帮助手册很全面，包括功能、注释规范、怎么配置、工具用法等。

doxygen的用法共3步:
1. 按照注释规范对代码加注释。
2. 配置选项。
3. 生成文档。

配置选项
可以使用命令行工具 doxyfen -g 生成一个配置模版，我直接使用带界面的配置向导来配。
向导中的三个选项卡：
1. wizard 进行大致的配置选择
2. expert 进行精细的配置
3. run 生成文档

配置界面第一步如图，其他步骤都很简单：

配置完以后，在run选项卡中生成即可。

说明
要正确的选择输入和输出等各种编码。
向导中的配置必须保存以后才能生成文档。

生成chm文档:
HHC_LOCATION 要填hhc.exe的绝对路径。
CHM_INDEX_ENCODING 必须是GBK，否则chm左侧是乱码。

原创文章，欢迎阅读，禁止转载。