自动生成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

RK3576开发板ROS2部署实战:从Buildroot配置到Hello World Demo

本文详细介绍了在RK3576开发板上部署ROS2的完整实战流程。从Buildroot工程配置、集成ROS2依赖,到搭建Docker交叉编译环境、处理编译难题,最终完成系统镜像打包并在板端成功运行Talker-Listener Demo。该指南旨在帮助开发者深入理解嵌入式机器人系统的构建链,实现从底层到应用的完全掌控。

mac99的博客 1159

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

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

gaoxuexidan0307的博客 1247

从零开始掌握机械臂运动控制:原理、建模与实践

本文系统介绍了机械臂运动控制的核心原理与实践方法。从运动学与动力学建模的基础理论出发,详细解析了经典PID控制与现代MPC(模型预测控制)算法的应用,并通过ROS与MATLAB仿真案例,指导读者从零开始实现机械臂的轨迹规划与精准控制,为工业自动化应用提供完整的技术路径。

weixin_29099217的博客 573

Doxygen初学与简单应用

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

自由的天空 9263

从交换机安全配置,看常见局域网攻击

前言 构建零信任网络,自然离不开网络准入(NAC),这就涉及到交换机的一些安全测试,于是有了此文《从交换机安全配置看常见局域网攻击》。 交换机安全配置 如本文标题所说从交换机安全配置看常见的局域网攻击,那么下面提到的各种攻击方式,自然是建立在交换机安全配置之上来说的。我们通过h3c官方提供的《H3C 交换机安全加固手册》和《安全配置指导》,从这两份手册可以看出交换机支持的安全配置非常多,基本已经覆盖了各种我们熟知局域网攻击。下面就挑几个典型的攻击方式进行演示。 arp欺骗 【一>所有资源获取&lt

kali_Ma的博客 1万+

修改注册表导致开机时电脑显示“无法登陆到你的账户”的问题解决方案

1.问题描述:开机电脑显示“无法登陆到你的账户:通常可以通过从你的账户注销,然后重新登陆来解决问题,如果不立即注销,你创建的任何文件或进行的任何更改都将会丢失。” 2.问题原因:想要修改cmd中的用户名(红色部分),修改了注册表,重启时出现问题。 3.问题解决: win+R输入cmd,确定进入注册表界面,将下面的地址复制进地址栏(你也可以自己按目录查找),双击ProfileImage...

qq_33835957的博客 7万+

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

当AI换脸遇上内容审核:Facefusion NSFW检测的技术伦理与用户自主权之争

本文探讨了Facefusion开源AI换脸工具中NSFW检测机制的技术伦理困境与用户自主权之争。分析了其多层次防御机制的技术实现与社区规避方法,揭示了开源软件在安全与自由之间的平衡难题,并提出了分层权限设计等社区实践方案。

weixin_29165725的博客 703

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

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

qq_41854911的博客 1万+

【数学建模】编程手学习路线

在学习过程中,建议注重理论与实践相结合,多进行实例练习和项目实践,以巩固所学知识并提升实际应用能力。同时,保持对新技术和新方法的关注和学习,不断提升自己的专业素养和竞争力。NumPy、Pandas、Matplotlib和Seaborn等库是数据处理和可视化的重要工具。掌握常用机器学习算法的原理和应用,如决策树、支持向量机、神经网络等。学习内容包括微积分、线性方程组、矩阵运算、概率分布、统计推断等。学习内容包括基本语法、函数和模块、面向对象编程、文件操作等。深入了解优化理论和方法,如梯度下降法、牛顿法等。

2301_79586491的博客 2963

学习STM32的流体水位传感器

引言: 流体水位传感器是一种常用于测量液体水位的设备,广泛应用于水位监测、液位控制和流量计量等领域。STM32是一款功能强大的单片机,具有丰富的外设和灵活的编程能力,非常适合用于流体水位传感器的开发。本文将介绍如何使用STM32开发板与流体水位传感器进行连接和通信,并通过编写代码实现水位的测量和显示。五、总结: 通过以上的代码示例,我们可以实现使用STM32开发板与流体水位传感器进行连接和通信的功能。三、编写代码: 以下是使用STM32CubeIDE编写的示例代码,实现了读取流体水位传感器的功能。

xiaoalla的博客 743

API文档自动生成工具

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

IT菜鸟 2207

【面试系列】软件架构师 高频面试题及详细解答

本文介绍了软件架构师岗位的初级、中级和高级面试题及详细解答,涵盖了系统设计、面向对象设计、分布式系统、云计算技术、性能优化等关键领域。通过这些问题和解答,候选人可以深入理解软件架构师的核心职责和技能要求。此外,文章总结了在面试中需要掌握的常考知识点,包括架构模式、分布式系统管理、安全性、数据管理和DevOps实践。通过掌握这些知识点,软件架构师能够有效设计和指导复杂系统的结构,确保系统的可扩展性、性能和维护性。

在路上的专栏 853

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

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

千人斩的博客 834

IDEA的使用指南

IDEA基于java的使用手册,可以最快速的上手,在使用中不断的丰富自己的使用技巧.

visio安装包

Microsoft Office Visio 是一款专业的制图软件。利用经过更新的形状、协作工具和数据链接图表,创建专业级图表以简化复杂的信息。

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

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

505

贝叶斯统计 [韦来生编]

贝叶斯(Bayes)统计是近几十年来迅速发展起来的数理统计的一个重要分支。贝叶斯方法与经典统计方法的主要不同之处是进行统计推断时除了利用样本信息外,还要利用参数的先验信息,因此可以提高统计推断或统计决策的效果。它在经济、金融、生物、医学、自然科学和社会科学等许多领域具有广泛的应用。贝叶斯方法的研究已渗透到了统计学的几乎所有领域。作者在给中国科学技术大学概率论与数理统计专业本科生开设的“数理统计”课程中有一章专门讲授“贝叶斯方法和统计决策理论”,近十年来也给中国科学技术大学概率统计专业研究生开设过几次“贝叶斯分析”课。本书是在对过去讲稿的内容作了适当的增减和调整的基础上完成的。  本书共分六章。第1章是绪论,介绍了贝叶斯统计的若干基本概念,同时对必要的数理统计的基础知识有重点地作了回顾。第二章介绍了确定先验分布的若干可供选择的方法。第三章介绍了几类常见统计模型参数的后验分布的主要结果和计算方法。第四章和第五章分别介绍了“贝叶斯统计推断”和“贝叶斯统计决策”的内容。第六章介绍了贝叶斯统计计算的若干方法,包括蒙特卡洛方法和马尔可夫链蒙特卡洛(MCMC)方法以及相关统计软件的简介。本书的每一章附右大量的例题和习题,书末附有常用的几个表格和部分习题解答供读者查用。  大约可在54学时内讲授本书的第1章至第六章的主要内容,教师可根据学时需要选讲本书第1章至第六章的部分内容。书中标“*”号的章节可略去不讲,留给读者作为阅读材料。第六章例题中的R代码和部分例题的数据文件等可从作者个人主页下载。  作者在编写本书的过程中参考了J.O.Berger教授的《统计决策论及贝叶斯分析》和茆诗松教授编写的《贝叶斯统计》等书中的一些内容,以及《贝叶斯分析》一书中由张伟平博士编写的有关贝叶斯统计计算的一些内容。在此表示衷心感谢。  本书编写准备过程中,中国科学技术大学统计与金融系的几个研究生帮助完成了本书部分中文的录入和排版,作者对他们的辛勤工作表示真诚的感谢。高等教育出版社为本书的出版给予了大力支持。在此一并致谢。

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

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

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

精雕软件(JDpaint) 5.5 绿色版

精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版

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、付费专栏及课程。

余额充值