使用Doxygen构建API Web文档

安装

安装包地址：Doxygen: Downloads

Windows下一路next即可

操作

本案例使用doxygen-awesome-css样式进行自定义生成，所以不需要创建doxygen项目文件Doxyfile，只需要基于上述项目文件目录进行调整即可；

注意：任何文件路径中不能包含中文，不然构建生成错误

1.9.5版本存在问题：C# 构建的文档项目的Enum存在问题，不会展示枚举值，可以使用1.9.4进行构建

使用doxygen需要对源码进行扫描，从源码中获取相关接口信息，最终生成文档；

1-编辑Doxyfile项目

1. 打开Doxyfile项目文件

使用doxy gui 工具打开 下载的doxygen-awesome-css文件夹中Doxyfile项目文件

2.配置相关信息

配置基本信息

配置源码语言

配置生成文档布局

配置文档输出语言

更多配置

a. 如果需要添加md说明文档，可以在此处添加

2-构建文档项目

1. 使用shfb gui工具

2. 使用cmd

前提：需要配置doxygen环境变量

命令

doxygen <Doxyfile文件路径>

完成

其他

主题

jothepro/doxygen-awesome-css

生成Web

Github - Generate By Doxygen