System.ArgumentOutOfRangeException: 索引和长度必须引用该字符串内的位置。 参数名: length 在 System.String.Substring(Int32 startIndex, Int32 length) 在 zhuanliShow.Bind()
【技术实现步骤摘要】
本专利技术涉及计算机,尤其涉及一种接口文档的生成方法、装置、电子设备及存储介质。
技术介绍
1、随着公司网络货运系统不断的深入迭代,分布式服务框架dubbo服务也越来越多,服务接口也越来越多,如果每个dubbo服务接口的接口文档都需要靠开发人员来手动维护的话,工作量会非常大,并且如果接口有更新就需要开发人员去对应更新接口文档,此工作很繁琐也非常容易遗漏导致接口文档信息错误。
2、综上可知,由于现有的dubbo服务接口的接口文档的生成方法需要依赖人工,效率低。
技术实现思路
1、本专利技术提供一种接口文档的生成方法、装置、电子设备及存储介质,用以解决接口文档的生成方法效率低的缺陷,实现提高接口文档的生产方法的效率。
2、第一方面,本专利技术提供一种接口文档的生成方法,包括:
3、识别java标准注释文档中的标签内容,所述java标准注释文档为对业务代码进行编译后的文档;
4、基于所述标签内容的上下级关系,构建所述java标准注释文档的至少一个java包;
5、基于所述java包的接口类型,生成所述java包的协同空间页面;
6、基于协同空间和所述协同空间页面,生成所述java标准注释文档的接口文档。
7、根据本专利技术提供的一种接口文档的生成方法,所述基于所述java包的接口类型,生成所述java包的协同空间页面,包括:
8、将所述java包填充到所述接口类型对应的虚拟机模板中,以生成所述
9、将所述目标文件存入协同空间初始页面中,得到所述协同空间页面。
10、根据本专利技术提供的一种接口文档的生成方法,所述协同空间页面由标题名称和目标内容组成,所述将所述目标文件存入协同空间初始页面中,得到所述协同空间页面,包括:
11、将所述目标文件的目标标题存入所述协同空间初始页面的标题模块,得到所述标题名称,所述标题名称包括父标题名称和子标题名称;
12、将所述目标文件的待存入内容存入所述协同空间初始页面的内容模块,得到所述目标内容,所述目标内容包括父标题内容和子标题内容。
13、根据本专利技术提供的一种接口文档的生成方法,所述基于协同空间和所述协同空间页面,生成所述java标准注释文档的接口文档,包括:
14、基于所述协同空间页面的过滤标识符,过滤掉不需要生成所述接口文档的所述协同空间页面;
15、检查过滤后的所述协同空间页面的标题名称,并提示存在相同的所述标题名称;
16、基于检查后的所述协同空间页面和所述协同空间,生成所述接口文档。
17、根据本专利技术提供的一种接口文档的生成方法,所述识别java标准注释文档中的标签内容,包括:
18、至少识别所述标签内容中的包标签、类标签、标注标签、接口标签、字段标签、类型标签、注释标签和注解标签;
19、至少显示所述标注标签中的接口地址标签、特殊说明标签、作者标识标签和变更数据库表标签。
20、根据本专利技术提供的一种接口文档的生成方法,所述基于所述标签内容的上下级关系,构建所述java标准注释文档的至少一个java包,包括:
21、将存在所述上下级关系的所述标签内容组成一个标签内容组;
22、对每个所述标签内容组的所述标签内容按照所述上下级关系进行编排,得到所述java包。
23、根据本专利技术提供的一种接口文档的生成方法,所述在识别java标准注释文档中的标签内容之前,还包括:获取所述java标准注释文档,所述获取所述java标准注释文档,包括:
24、调用代码托管与协作平台,以获取代码托管与协作平台识别的所述业务代码;
25、基于所述代码托管与协作平台的持续集成工具,对所述业务代码进行编译,并生成所述java标准注释文档。
26、第二方面,本专利技术提供一种接口文档的生成装置,包括:
27、识别模块,用于识别java标准注释文档中的标签内容,所述java标准注释文档为对业务代码进行编译后的文档;
28、java包生成模块,用于基于所述标签内容的上下级关系,构建所述java标准注释文档的至少一个java包;
29、协同空间页面生成模块,用于基于所述java包的接口类型,生成所述java包的协同空间页面;
30、接口文档生成模块,用于将所述协同空间页面上传至协同空间,并基于协同空间和所述协同空间页面,生成所述java标准注释文档的接口文档。
31、第三方面,本专利技术提供一种电子设备,包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序,所述处理器执行所述程序时实现如上述任一种所述接口文档的生成方法的步骤。
32、第四方面,本专利技术还提供一种非暂态计算机可读存储介质,其上存储有计算机程序,该计算机程序被处理器执行时实现如上述任一种所述接口文档的生成方法的步骤。
33、本专利技术提供的接口文档的生成方法、装置、电子设备及存储介质,识别java标准注释文档中的标签内容,所述java标准注释文档为对业务代码进行编译后的文档;基于所述标签内容的上下级关系,构建所述java标准注释文档的至少一个java包;基于所述java包的接口类型,生成所述java包的协同空间页面;基于协同空间和所述协同空间页面,生成所述java标准注释文档的接口文档。本专利技术实施例根据标签内容的上下级关系,生成java包,实现了自动生成java包;根据接口类型,生成协同空间页面,在实现自动生成协同空间页面的同时,提高了生成协同空间页面的准确性。根据协同空间,自动生成接口文档,提高了生成接口文档的效率。
本文档来自技高网...【技术保护点】
1.一种接口文档的生成方法,其特征在于,包括:
2.根据权利要求1所述的接口文档的生成方法,其特征在于,所述基于所述Java包的接口类型,生成所述Java包的协同空间页面,包括:
3.根据权利要求2所述的接口文档的生成方法,其特征在于,所述协同空间页面由标题名称和目标内容组成,所述将所述目标文件存入协同空间初始页面中,得到所述协同空间页面,包括:
4.根据权利要求1所述的接口文档的生成方法,其特征在于,所述基于协同空间和所述协同空间页面,生成所述Java标准注释文档的接口文档,包括:
5.根据权利要求1所述的接口文档的生成方法,其特征在于,所述识别Java标准注释文档中的标签内容,包括:
6.根据权利要求1所述的接口文档的生成方法,其特征在于,所述基于所述标签内容的上下级关系,构建所述Java标准注释文档的至少一个Java包,包括:
7.根据权利要求1所述的接口文档的生成方法,其特征在于,所述在识别Java标准注释文档中的标签内容之前,还包括:获取所述Java标准注释文档,所述获取所述Java标准注释文档,包
8.一种接口文档的生成装置,其特征在于,包括:
9.一种电子设备,包括存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序,其特征在于,所述处理器执行所述计算机程序时实现如权利要求1至7任一项所述接口文档的生成方法的步骤。
10.一种非暂态计算机可读存储介质,其上存储有计算机程序,其特征在于,所述计算机程序被处理器执行时实现如权利要求1至7任一项所述接口文档的生成方法的步骤。
...【技术特征摘要】
1.一种接口文档的生成方法,其特征在于,包括:
2.根据权利要求1所述的接口文档的生成方法,其特征在于,所述基于所述java包的接口类型,生成所述java包的协同空间页面,包括:
3.根据权利要求2所述的接口文档的生成方法,其特征在于,所述协同空间页面由标题名称和目标内容组成,所述将所述目标文件存入协同空间初始页面中,得到所述协同空间页面,包括:
4.根据权利要求1所述的接口文档的生成方法,其特征在于,所述基于协同空间和所述协同空间页面,生成所述java标准注释文档的接口文档,包括:
5.根据权利要求1所述的接口文档的生成方法,其特征在于,所述识别java标准注释文档中的标签内容,包括:
6.根据权利要求1所述的接口文档的生成方法,其特征在于,所述...
【专利技术属性】
技术研发人员:姚军,
申请(专利权)人:北京汇通天下物联科技有限公司,
类型:发明
国别省市:
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。