自动生成API文档工具使用(doxygen)

Doxygen自动生成api接口文档 它从源代码注释自动生成文档,解析类、函数和变量的信息,以生成HTML和PDF等格式的输出。通过简化和标准化文档过程,Doxygen增强了跨不同编程语言和项目规模的协作和维护。时间流逝、年龄增长,是自己的磨炼、对知识技术的应用,还有那不变的一颗对嵌入式热爱的心!在生成目前下会生成对应的文件(前面选择了哪些文件输出,就会输出哪些),然后回车,就会快速生成对应的格式的注释框架,手动填充完整就好。如果不愿意手动写注释,可以去看看这篇文档,使用AI自动完成注释。暂无,可以关注我的B站账号等待更新。 阅读详情

首先,这个工具有什么用,累死累活搞完代码了,几万行下来,新人还得给他讲怎么写的,流程怎么跑的,我现在的做法是,把核心流程讲给他听,然后这个工具生成的API文档一丢,自己玩去吧。
先到github上找到项目,找到他的安装文档下的windows的链接,下载下来
在这里插入图片描述
一路安装就行了
打开doxygen gui frontend
首先要做的是有一份源代码他的注释格式要能被doxygen能识别,比如///代替//

源代码可能还会不是UTF-8格式的,会报错,我的做法是找一个工具批量生成UTF-8格式
在这里插入图片描述
下载安装,批量生成

还会用到微软的htmlhelp.exe,百度一下,然后安装,比较老的东西了,链接自己找,我们会用到hhc.exe
在这里插入图片描述

在这里插入图片描述
在这里插入图片描述
准备只生成chm文档
在这里插入图片描述
不用生成关系图
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

apidox:RESTful API的实时交互式文档和浏览 Apidox 用于RESTful API的 Live Interactive文档和浏览, Apidox 有关更多信息,请参见Apidox 。 描述 Apidox是一个小型,简单且功能强大PHP应用程序,可通过源代码中的API XML结构定义或注释创建文档。 使用Apidox,您的开发人员可以花费更少的时间进行切换,剪切和粘贴,甚至可以在多个环境中测试API甚至花费更多的时间来编写出色的应用程序,因为Apidox允许您即时更改基本URL。 APIDox为您提供: 支持XML:使用简单的XML结构即可轻松生成。 实时API:开发人员可以直接从API文档执行调用。 文档:一个用于文档和测试的地方。 易玩:通过API预先填充的测试值。 交换服务器:在测试之前更改服务器环境。 共享API:与您的队友或客户共享。 Apidox Web应用程序最低要求 启用了CURL的任何Web 立即下载

相关推荐

Microsoft HTML Help hhc.exe

Microsoft HTML Help 来自于https://code.google.com/archive/p/chmwriter/downloads 里面的hhc

【Doxygen】Doxygen使用教程(个人总结)

【Doxygen】Doxygen使用教程(个人总结) 简介Doxygen 引言.什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您

qq_43331089的博客 5万+

hhc.exe 文件出品公司: Microsoft Corporation 文件所属产品: HTML Help

文件出品公司: Microsoft Corporation 文件所属产品: HTML Help 文件版本号: 4.74.8702.0 文件大小: 50.2KB

【Doxygen】Doxygen使用配置及注释语法规范

本文记录了使用Doxygen的gui进行相关配置并生成对应注释文档的相关过程,解释了Doxygen的注释语法规范,并简单介绍了在vscode中配置插件的相关事项。

Stay_Hun_forward的博客 8066

hhc.exe制作chm文件

hhc.exe制作chm文件,里面包含了hha.dll

【前端HTML生成条形码——MQ】

本文将展示前端HTML如何根据用户输入内容生成对应的条形码,附HTML和JS代码。代码如下(示例):

weixin_42588676的博客 1957

ASPICE SWE3之——C代码生成软件详细设计1 Doxygen配置

前面已经单独一篇文章讲了,若想通过Doxygen工具生成C代码的软件详细设计文档,需要C代码注释的格式,并推荐了注释规范,以满足Doxygen工具识别格式,且符合ASPICE对详细设计的内容要求,且尽可能使注释内容简洁并生成报告好看。 本文接下来讲,若想通过Doxygen工具生成C代码的软件详细设计文档,需要下载哪些软件,软件包放在资源中需要自取,Doxygen工具该如何配置,若想生成报告成功需要注意什么。 配置过程经常会因为一些细节问题导致生成报告出现问题,本文的配置亲测有效。.........

gaoxuexidan0307的博客 1247

LDO稳定性分析

根据补偿方式和拓扑结构的不同,三个极点之间的相互位置有可能发生变化,但 是 LDO 通常采用较大的输出电容 Cout,以及较大的调整管也会导致较大的 Cpar, 所以 p1、p2 通常位于较低的频率处,而 p3 和 z1 则由于 Resr较小会位于较高的频 率处。不过幸运的是,对于较大的 Cout来说,只要选择合适的 Resr,就可以将左半平面零点 Z1 的频率降低,甚至使 Z1 进入单位增益带宽内,左半平面零点的进入将对相位有所改善,这不仅可以消除振荡的风险,还可以在单位增益频率处得到较好的相位裕度。

模拟芯片设计 1595

Doxygen初学与简单应用

出处:http://my.oschina.net/hava/blog/110874安装包下载地址:https://download.youkuaiyun.com/download/wuhenyouyuyouyu/10365449本文环境为Windows 7 x64一直在使用javadoc,奈何c\c++,python等其他语言注释写的很好,但没有工具自动生成文档。通过同事反应Doxygen可以针对各种语言生成...

自由的天空 9263

手把手教你:在联想/戴尔笔记本上安装华为电脑管家,实现多屏协同(附详细避坑步骤)

本文详细指导如何在联想、戴尔等非华为笔记本上安装华为电脑管家,实现多屏协同功能。从硬件兼容性检查到定制化安装流程,再到功能调优与异常处理,提供了一套完整的解决方案,帮助用户突破品牌限制,享受华为生态的高效办公体验。

weixin_30251829的博客 864

电池充电管理芯片规格书精读指南:从参数解析到设计实战

电池充电管理是嵌入式系统和便携式设备开发中的基础环节,其核心在于理解并应用充电芯片的规格参数。充电芯片通过精确控制电压、电流、温度等关键参数,实现对锂电池等可充电电池的安全、高效管理。掌握这些参数原理,对于优化产品功耗、提升充电效率、保障电池寿命具有重要技术价值,广泛应用于智能穿戴、消费电子、无人机等场景。本文聚焦于**充电电流**设定与**热管理**等核心参数,深入解析其相互影响与工程选型中的权衡,旨在帮助开发者将抽象的规格书数据转化为可靠的电路设计依据,从而有效排查充电故障,提升产品整体可靠性。

weixin_26874745的博客 669

Doxygen wizard

Doxygen GUI fontend为Doxygen的界面操作工具。本篇为wizard项的界面翻译。 step1 : Specify the working directory from which doxygen will run 设置doxygen的工作路径 step2 : Configure doxygen using the Wizard and/or Expert tab, then...

程序员Link 816

微信DAT图片恢复全攻略:从文件定位到批量解密(附最新路径变化)

本文提供了一份详尽的微信DAT图片恢复指南,涵盖新旧版本文件路径变化解析、DAT文件定位方法以及批量解密操作步骤。针对微信图片加密存储为DAT格式的痛点,文章介绍了高效易用的图形化解密工具,帮助用户将加密文件快速还原为JPG、PNG等可查看格式,并强调了数据安全与隐私保护的重要性。

p4q5r6s7t的博客 746

代码文档生成工具Doxygen教程及实例

程序员的很多文档,特别是有代码的文档,绝大部分都是由一款文档生成工具【Doxygen】生成。 什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。 大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用你的程序代码的人而言将会减少许多的负担。不过,反过来说,整.

qq_41854911的博客 1万+

DeepSeek的训练与优化流程

DeepSeek的训练体系不仅追求极致的计算效率,更注重将物理规律、人类知识、安全伦理深度融入训练过程,其"效率-安全-可解释性"三角平衡的设计理念,为行业提供了重要参考范式。

m0_56896669的博客 1438

【笔记】2022.6.7 数据分析概论

已完结

SpriteNym的博客 1374

API文档自动生成工具

大部分情况,我们不希望维护一份代码再加上一份文档,这样做很容易造成文档和代码的不一致,程序员最讨厌更新文档了。python环境自带,但是有点过于简单,只能一个个指定文件/类/模块来生成文档,生成的内容缺省输出到控制台,还得重定向到文件,优势是原生支持Markdown。关于图片的引用,sphinx会自动将图片文件移动到_images文件夹下,不同文件夹下的图片都会移动到这个文件夹下,图片名称。关于图片不同文件夹下名称相同,移动后会将同名的文件进行重命名,添加序号之类的,因此不会影响实际显示效果。

IT菜鸟 2207

Python 爬虫实战:模拟登录网易云音乐(加密接口逆向与自动化登录实现)

网易云音乐作为国内主流的音乐流媒体平台,其丰富的音乐资源和个性化推荐算法吸引了大量用户。对于开发者而言,模拟登录网易云音乐并实现自动化操作,可以用于数据分析、歌单同步、歌词抓取等场景。然而,网易云音乐采用了多重加密机制和反爬策略,直接模拟登录存在较大挑战。

yansideyucsdn的博客 2592

Doxygen代码注释规范及API文档生成

第1章 API文档 API(Application Programming Interface)文档是描述如何使用代码库提供的功能的说明文档,包括接口的介绍,使用方法,参数等信息。良好的API文档,可以使开发人员更快的学习API的用法,并集成到他们的软件中。也可以给测试人员用于设计接口的测试用例,包括对功能,逻辑,异常等的测试。 1.1.包含哪些内容 API文档必要包含的部分有,接口名称,功能描述,参数说明(名称,类型,是否可选,说明),返回值说明(类型,意义),使用示例(针对单个接口或一组接口)等。 1.

千人斩的博客 834

efm32 入门.pdf

本PDF共计22页,介绍的是操作驱动API,下载与否自己斟酌。

Probability and Statistics - 4th edition

Probability and Statistics - 4th edition

【转】使用Doxygen工具生成Cocos2D…

原地址:http://www.cnblogs.com/yssgyw/p/3208664.html Doxygen是一种开源跨平台的工具,其功能是从程序源代码中抽取类、方法、成员的注 释,形成一个和源代码配套的API(Application Programming Interface,应用程序编程接口)帮助文档。Doxygen工具,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Ja

505

Data-Structures-and-Algorithm-Analysis-in-Java.pdf

作者: Weiss, Mark A. 出版社: Addison Wesley Data Structures and Algorithm Analysis in Java is an “advanced algorithms” book that fits between traditional CS2 and Algorithms Analysis courses. In the old ACM Curriculum Guidelines, this course was known as CS7. This text is for readers who want to learn good programming and algorithm analysis skills simultaneously so that they can develop such programs with the maximum amo...

g2o通过doxygen生成代码解释文件

doxygen的使用,在使用的库没有api函数介绍时及其不方便。本文介绍通过doxygen自动为开源代码的注释生成解释文件!

主要学习关于图像处理和SLAM领域 396

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

doxygen

http://www.stack.nl/~dimitri/doxygen/ Generate documentation from source code 转载于:https://www.cnblogs.com/dmdj/p/4200735.html

weixin_34008805的博客 100

Doxygen 文档生成系统标签详解

Doxygen 是一个功能强大的文档生成工具,主要用于C++、C、Java等编程语言。通过在代码中添加特定格式的注释,Doxygen可以自动生成完整的API文档。

抟土成人祖,炼石补青天。眼中览银河,手可摘星辰。 685

Debian下使用Doxygen生成定制样式的开发文档

背景: 别人会用到我们平台的功能接口,但当前平台没有功能使用文档,很多接口别人不知道具体用法。而我们又不想单独维护一个平台使用文档,每次更新类或接口还要再单独刷新下使用文档是件很痛苦的事情。故我们使用了Doxygen工具自动生成产品文档,每次修改代码只要添加或者更新注释即可直接更新产品文档,很是方便。 目标: 凡事要有目标,然后才好有的放矢吧。 我们要提供网页版的开发文档,页头有公司logo, 文档名称,文档版本号,以及最右侧的搜索框。 页面最左侧是个导航树,导航树分三大层级: 第一层介绍此开发文档怎么使用

agang1986的博客 1081

编辑chm格式的文档

chm (Compiled HTML Help,即“编译的HTML帮助文件”) CHM 文件格式是微软于 1998 年推出的基于 HTML 文件特性的帮助文件系统,以替代早先的 WinHelp 帮助系统。它在 Windows 98 中把 CHM 类型文件称作“编译的 HTML 帮助文件”(Compiled HTML Help file) 1,生成HTML,可以使用windows自带的C:/P...

guanguanboy的专栏 2193
上一篇: docker学习笔记
下一篇: googletest笔记
duling2
博客等级 码龄10年 41粉丝 40原创
评论 2
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值