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

最新推荐文章于 2024-05-31 10:34:50 发布
最新推荐文章于 2024-05-31 10:34:50 发布
阅读量393 收藏 3
点赞数
分类专栏： 学习笔记 各类框架学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/duling2/article/details/115477461
版权

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

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

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

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

duling2
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
使用doxygen自动对python api做接口文档及生成帮助文档
womende3ban的博客
05-25 804
原本的word文档中的函数是以表格形式存在，可以正常转为HTML显示，但引索是word的标题而且还会因为 chm在windows下的软件仅支持GB2312而实际word转html为unicode造成乱码。（还有个同事N+1年前的老chm就可以搜索，那个文件是用word拆成单独的文件，用word本身的doc转html转后用，ms html helper 合并的，就可以搜索）需要的是制作好后的文档，最好有接口函数名称（中/英）文的引索，正文可以搜索（模糊检索），方便查询操作接口函数用以编制自动测试用的脚本。
python生成api文档_文档API生成工具
weixin_39874379的博客
11-26 1355
1. Python1.1. pydoc（python自带，已废弃）据说配色及其丑陋……1.2. pdoc（注意，不是pydoc）pdoc 是一个简单易用的命令行工具，可以生成 Python 的 API 文档。1.3. SphinxPython有个自带的工具可以生成API项目文档——pydoc，但Python3官方文档却是由sphinx生成的。可见Sphinx已成为Python项目首选的文档工具，同...
Doxygen —— 快来为你的代码自动生成一份专属说明文档
Rosen的博客
03-26 5600
Doxygen是一个能从带注释的源码中自动生成说明文档的标准工具，它支持众多流行的编程语言，包括C/C++、C#, PHP, Java, Python, IDL 等
Doxygen自动生成api接口文档
最新发布
zhuzhu的博客
05-31 460
它从源代码注释自动生成文档，解析类、函数和变量的信息，以生成HTML和PDF等格式的输出。通过简化和标准化文档过程，Doxygen增强了跨不同编程语言和项目规模的协作和维护。时间流逝、年龄增长，是自己的磨炼、对知识技术的应用，还有那不变的一颗对嵌入式热爱的心！在生成目前下会生成对应的文件（前面选择了哪些文件输出，就会输出哪些）,然后回车，就会快速生成对应的格式的注释框架，手动填充完整就好。如果不愿意手动写注释，可以去看看这篇文档，使用AI自动完成注释。暂无，可以关注我的B站账号等待更新。
C/C++生成API文档_使用Doxygen
weixin_41477689的博客
10-25 1337
1、工具下载及安装 Linux直接安装 sudo apt-get install doxygen sudo apt-get install graphviz 2、生成配置文件 doxygen -g doxygen -g 生成文件名 3、生成API文档 doxygen 参考：Linux Doxygen的安装和使用 - 红孩儿你好 - 博客园 ...
doxygen注释生成api文档(一)
qq_25105061的博客
10-11 350
doxygen注释的使用规则
如何利用doxygen生成代码的API文档
qq_31638535的博客
07-08 292
1. 首先写代码的注释一定要follow doxygen的格式https://www.doxygen.nl/manual/grouping.html 2. 有了代码之后，生成一个congig文件， doxygen -g config_file 3. 根据https://www.doxygen.nl/manual/config.html这里修改默认的参数 4. doxygen config_file 生成api文档 5. 生成的文档html里面有一个index.html打开就可以看api的信息了 .
API文档生成工具——Doxygen
liao20081228的博客
08-17 6892
1 简介   为代码写注释一直是大多数程序员有些困扰的事情。更头痛的是写文档，以及维护文档的问题，而doxygen就能把遵守某种格式的注释自动转化为对应的文档。   Doxygen是基于GPL的开源项目，是一个非常优秀的文档系统，当前支持在大多数unix（包括linux），windows家族，Mac系统上运行，完全支持C++, C, Java, IDL（Corba和Microsoft 家族...
代码文档生成工具Doxygen教程及实例
qq_41854911的博客
04-29 9777
程序员的很多文档，特别是有代码的文档，绝大部分都是由一款文档生成工具【Doxygen】生成。 什么是Doxygen? Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。 大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用你的程序代码的人而言将会减少许多的负担。不过，反过来说，整.
Python-php注释自动生成api文档
08-10
标题 "Python-php注释自动生成api文档" 暗示我们关注的是一个使用Python编写的工具，该工具能够从PHP代码中的注释自动提取信息，生成API文档。这个过程通常称为文档自动化，对于提高开发效率和团队协作至关重要。 ...
doxygen代码文档生成工具
01-11
**doxygen代码文档生成工具** Doxygen是一款强大的开源文档生成工具，主要面向C++，但同时也支持其他编程语言，如C、C#、Java、Python等。它通过解析源代码中的注释，自动生成结构化的专业文档，帮助开发者理解和...
doxygen 文档自动生成工具
03-19
doxygen 1.61 十分好用的文档自动生成工具，尤其适合生成api手册。 示例、chm自动编译插件打包。关系图生成插件graphviz放在另外的链接提供下载，链接为http://download.csdn.net/source/2143324
doxygen和graphviz文档生成工具.rar
06-29
当开发或维护一个大型的osg项目时，使用doxygen和graphviz结合可以生成详细的API文档，包括类、函数、变量的解释，以及类之间的关系图，这对理解和使用osg库非常有帮助。 在压缩包中，"graphviz.rar"和"doxygen.rar...
doxygen帮助文档生成工具
11-30
Javadoc是Java语言的文档生成工具，它通过解析源代码中特定格式的注释，生成HTML格式的API文档。Doxygen借鉴了这一概念，允许C++开发者使用类似的注释方式，例如`/** ... */`多行注释或`//`单行注释，来标注类、函数...
VBA笔记
duling2的博客
05-15 7274
打开VBE即编写VBA的IDE的快捷键 ALT+ F11 提示代码 CTRL+j 在代码窗口VBA.会自动列出所有的函数 在VBE的帮助中输入对象模型就能看到对象的关系了 引用类型 $A$1 //绝对引用，复制公式时不改变单元格地址 A1 相对引用，复制公式时会改变引用单元格地址 IF（逻辑值，TRUE时的返回结果，FALSE时返回的结果） &在表中是连接符，连接表格的内容 VBA的数据类型 字节 Byte 整数 Integer 长整..
GetTickCount64的使用
duling2的博客
11-01 5529
ULONGLONG lastTick = GetTickCount64(); Sleep(2000); ULONGLONG nowTick = GetTickCount64(); if(lastTick-nowTick>3500) { //永远不会走这里 }else { //会一直走这是 } //要改成这样 if (nowTick >= lastTick + 3500){ } else{ } ...
shark恒破解视频的笔记
duling2的博客
10-19 2105
shark恒破解笔记 第1期-03 壳内寻找注册码 1、F9先运行程序 2、Ctrl+G输入401000到解码段，如果出现db ** 鼠标右键->分析->从模块中删除分析 在这可以搜索字符串 并在需要的地方下断点a,b,c 3、下个GetStartupInfoA断点，重新运行,让程序在解码后未真正"运行"前断下来 4、观察断点窗口,前面下的断点a,b,c如果显示是add byte ...
Doxygen自动化文档生成工具详解
"Doxygen使用指南，自动生成文档工具，C++，C，Java，IDL，PHP，C#，HTML，Latex，RTF，ps，PDF，UnixManpage" Doxygen是一个强大的开源文档生成工具，它能够从源代码中的特定注释格式自动创建文档，支持多种编程...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值