[发明专利]API文档的生成方法与装置、存储介质及计算机设备在审
| 申请号： | 201910688147.7 | 申请日： | 2019-07-29 |
| 公开（公告）号： | CN110471698A | 公开（公告）日： | 2019-11-19 |
| 发明（设计）人： | 黄兴鲁 | 申请（专利权）人： | 深圳数位传媒科技有限公司 |
| 主分类号： | G06F8/73 | 分类号： | G06F8/73;G06F16/178 |
| 代理公司： | 44395 广东良马律师事务所 | 代理人： | 李良<国际申请>=<国际公布>=<进入国 |
| 地址： | 518000 广东省深圳市南山区*** | 国省代码： | 广东;44 |
| 权利要求书： | 查看更多 | 说明书： | 查看更多 |
| 摘要： | 本发明公开了一种API文档的生成方法与装置、存储介质及计算机设备，其中该API文档的生成方法包括：获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本；根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档。本发明解决了现有技术中的以下问题：由于API文档和其对应的代码是分开的，API文档的管理需要有人专门去维护，但是在开发过程中，我们需要经常修改API的定义，要求API文档要同步更新，而我们经常忘记更新API文档，导致API文档描述不符合现有API的定义，API文档描述落后于当前API的实际功能。 | ||
| 搜索关键词： | 文档 目标代码 同步脚本 文档描述 计算机设备 存储介质 开发过程 实际功能 同步更新 更新 维护 管理 开发 | ||
【主权项】：
1.一种API文档的生成方法，其特征在于，包括：/n获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本；/n根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档；/n其中，所述目标API代码、所述目标代码注释和所述同步脚本由开发者完成编写并存储于目标代码数据库。/n
下载完整专利技术内容需要扣除积分，VIP会员可以免费下载。
该专利技术资料仅供研究查看技术是否侵权等信息，商用须获得专利权人授权。该专利全部权利属于深圳数位传媒科技有限公司，未经深圳数位传媒科技有限公司许可，擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作，请联系【客服】
本文链接：http://www.vipzhuanli.com/patent/201910688147.7/，转载请声明来源钻瓜专利网。
- 上一篇：配置方法及相关产品
- 下一篇：用于指令处理的处理器核、方法和系统
