[发明专利]一种自动根据字段获取注释生成接口文档的方法在审
| 申请号： | 202210254956.9 | 申请日： | 2022-03-15 |
| 公开（公告）号： | CN114637532A | 公开（公告）日： | 2022-06-17 |
| 发明（设计）人： | 吕火生;孔令超;何健进;陈啟铭;黄世志;邓维滔 | 申请（专利权）人： | 佛山众陶联供应链服务有限公司;西藏众陶联供应链服务有限公司 |
| 主分类号： | G06F8/73 | 分类号： | G06F8/73;G06F8/41;G06F8/30 |
| 代理公司： | 佛山市禾才知识产权代理有限公司 44379 | 代理人： | 刘羽波;陈嘉琦 |
| 地址： | 528000 广东省佛山市禅城区南庄镇陶博*** | 国省代码： | 广东;44 |
| 权利要求书： | 查看更多 | 说明书： | 查看更多 |
| 摘要： | |||
| 搜索关键词： | 一种 自动 根据 字段 获取 注释 生成 接口 文档 方法 | ||
【权利要求书】：
1.一种自动根据字段获取注释生成接口文档的方法，其特征在于，包括如下步骤：
步骤一：在Java的class源文件的字段上增加对描述该字段的注释；
步骤二：根据Java的class源文件的字段，使用builder设计模式，根据字段名称的命名规则，生成与字段名称相同的链式调用的方法；
步骤三：根据接口文档所需字段，调用与字段名称相同的链式方法，来定义接口文档；
步骤四：根据链式方法调用后的返回值来获取class源文件对应的字段，并获取该字段对应的注释，以生成接口文档的字段。
2.根据权利要求1所述一种自动根据字段获取注释生成接口文档的方法，其特征在于：
在所述步骤三中，根据接口文档所需字段，调用与字段名称相同的链式方法，来定义接口文档，包括：
在每个接口所对应的方法上，使用被注释的参数来定义接口文档的实现类，所述实现类包括第一方法和第二方法，所述第一方法定义接口请求参数的字段，所述第二方法定义接口响应参数的字段。
3.一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，其特征在于：
所述计算机程序被处理器执行时实现如权利要求1-2任一项所述方法的步骤。
下载完整专利技术内容需要扣除积分，VIP会员可以免费下载。
该专利技术资料仅供研究查看技术是否侵权等信息，商用须获得专利权人授权。该专利全部权利属于佛山众陶联供应链服务有限公司;西藏众陶联供应链服务有限公司，未经佛山众陶联供应链服务有限公司;西藏众陶联供应链服务有限公司许可，擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作，请联系【客服】
本文链接：http://www.vipzhuanli.com/pat/books/202210254956.9/1.html，转载请声明来源钻瓜专利网。
- 上一篇：一种企业电量信息申报系统
- 下一篇：飞行器攻击行为预测方法及电子设备
