Doxygen自动生成api接口文档

本文目录


文章对应视频教程:

暂无,可以关注我的B站账号等待更新。


点击图片或链接访问我的B站主页~~~


1、引言

Doxygen是软件开发中广泛使用的文档生成工具。它从源代码注释自动生成文档,解析类、函数和变量的信息,以生成HTML和PDF等格式的输出。通过简化和标准化文档过程,Doxygen增强了跨不同编程语言和项目规模的协作和维护。


2、下载安装

doxygen下载链接

选择合适的版本下载,本文以win11为例。等待安装完成


3、准备对应的代码注释

准备一个有注释的项目,注释风格需要时JavaDoc风格

如果没有相应的注释,可以下载一个vscode插件,该组件可以快速生成相应风格的注释:

安装完成插件后,在函数上方输入/**,然后回车,就会快速生成对应的格式的注释框架,手动填充完整就好。

如果不愿意手动写注释,可以去看看这篇文档,使用AI自动完成注释。


点击图片或链接访问文章~~~


4、生成api文档

打开Doxygen软件。

点击Mode,进行设置

点击Next,在Run界面点击Run Doxygen

去对应的文件夹下打开网页

在生成目前下会生成对应的文件(前面选择了哪些文件输出,就会输出哪些)


时间流逝、年龄增长,是自己的磨炼、对知识技术的应用,还有那不变的一颗对嵌入式热爱的心!

到这里就结束了!希望大家给我的文章和B站视频
点赞o( ̄▽ ̄)d、关注(o)/~、评论(▽)!

相关推荐
妙为3 个月前
doxygen制作接口文档
doxygen·制作接口文档·chm
kwkwc6 个月前
使用 Gin-Docs 自动生成 API 文档
go·api·gin·文档·自动生成
Laurence8 个月前
使用 JMeter 生成测试数据对 MySQL 进行压力测试
jmeter·mysql·压力测试·测试数据·自动生成