CN118034778A - 接口文档的生成方法、装置、电子设备及存储介质 - Google Patents

Abstract

本发明提供一种接口文档的生成方法、装置、电子设备及存储介质，属于计算机技术领域，所述方法包括：识别Java标准注释文档中的标签内容；基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；基于Java包的接口类型，生成Java包的协同空间页面；基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。本发明根据标签内容的上下级关系，生成Java包，实现了自动生成Java包；根据接口类型，生成协同空间页面，在实现自动生成协同空间页面的同时，提高了生成协同空间页面的准确性。根据协同空间，自动生成接口文档，提高了生成接口文档的效率。

Description

接口文档的生成方法、装置、电子设备及存储介质

技术领域

本发明涉及计算机技术领域，尤其涉及一种接口文档的生成方法、装置、电子设备及存储介质。

背景技术

随着公司网络货运系统不断的深入迭代，分布式服务框架Dubbo服务也越来越多，服务接口也越来越多，如果每个dubbo服务接口的接口文档都需要靠开发人员来手动维护的话，工作量会非常大，并且如果接口有更新就需要开发人员去对应更新接口文档，此工作很繁琐也非常容易遗漏导致接口文档信息错误。

综上可知，由于现有的dubbo服务接口的接口文档的生成方法需要依赖人工，效率低。

发明内容

本发明提供一种接口文档的生成方法、装置、电子设备及存储介质，用以解决接口文档的生成方法效率低的缺陷，实现提高接口文档的生产方法的效率。

第一方面，本发明提供一种接口文档的生成方法，包括：

识别Java标准注释文档中的标签内容，所述Java标准注释文档为对业务代码进行编译后的文档；

基于所述标签内容的上下级关系，构建所述Java标准注释文档的至少一个Java包；

基于所述Java包的接口类型，生成所述Java包的协同空间页面；

基于协同空间和所述协同空间页面，生成所述Java标准注释文档的接口文档。

根据本发明提供的一种接口文档的生成方法，所述基于所述Java包的接口类型，生成所述Java包的协同空间页面，包括：

将所述Java包填充到所述接口类型对应的虚拟机模板中，以生成所述Java包的目标文件；

将所述目标文件存入协同空间初始页面中，得到所述协同空间页面。

根据本发明提供的一种接口文档的生成方法，所述协同空间页面由标题名称和目标内容组成，所述将所述目标文件存入协同空间初始页面中，得到所述协同空间页面，包括：

将所述目标文件的目标标题存入所述协同空间初始页面的标题模块，得到所述标题名称，所述标题名称包括父标题名称和子标题名称；

将所述目标文件的待存入内容存入所述协同空间初始页面的内容模块，得到所述目标内容，所述目标内容包括父标题内容和子标题内容。

根据本发明提供的一种接口文档的生成方法，所述基于协同空间和所述协同空间页面，生成所述Java标准注释文档的接口文档，包括：

基于所述协同空间页面的过滤标识符，过滤掉不需要生成所述接口文档的所述协同空间页面；

检查过滤后的所述协同空间页面的标题名称，并提示存在相同的所述标题名称；

基于检查后的所述协同空间页面和所述协同空间，生成所述接口文档。

根据本发明提供的一种接口文档的生成方法，所述识别Java标准注释文档中的标签内容，包括：

至少识别所述标签内容中的包标签、类标签、标注标签、接口标签、字段标签、类型标签、注释标签和注解标签；

至少显示所述标注标签中的接口地址标签、特殊说明标签、作者标识标签和变更数据库表标签。

根据本发明提供的一种接口文档的生成方法，所述基于所述标签内容的上下级关系，构建所述Java标准注释文档的至少一个Java包，包括：

将存在所述上下级关系的所述标签内容组成一个标签内容组；

对每个所述标签内容组的所述标签内容按照所述上下级关系进行编排，得到所述Java包。

根据本发明提供的一种接口文档的生成方法，所述在识别Java标准注释文档中的标签内容之前，还包括：获取所述Java标准注释文档，所述获取所述Java标准注释文档，包括：

调用代码托管与协作平台，以获取代码托管与协作平台识别的所述业务代码；

基于所述代码托管与协作平台的持续集成工具，对所述业务代码进行编译，并生成所述Java标准注释文档。

第二方面，本发明提供一种接口文档的生成装置，包括：

识别模块，用于识别Java标准注释文档中的标签内容，所述Java标准注释文档为对业务代码进行编译后的文档；

Java包生成模块，用于基于所述标签内容的上下级关系，构建所述Java标准注释文档的至少一个Java包；

协同空间页面生成模块，用于基于所述Java包的接口类型，生成所述Java包的协同空间页面；

接口文档生成模块，用于将所述协同空间页面上传至协同空间，并基于协同空间和所述协同空间页面，生成所述Java标准注释文档的接口文档。

第三方面，本发明提供一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现如上述任一种所述接口文档的生成方法的步骤。

第四方面，本发明还提供一种非暂态计算机可读存储介质，其上存储有计算机程序，该计算机程序被处理器执行时实现如上述任一种所述接口文档的生成方法的步骤。

本发明提供的接口文档的生成方法、装置、电子设备及存储介质，识别Java标准注释文档中的标签内容，所述Java标准注释文档为对业务代码进行编译后的文档；基于所述标签内容的上下级关系，构建所述Java标准注释文档的至少一个Java包；基于所述Java包的接口类型，生成所述Java包的协同空间页面；基于协同空间和所述协同空间页面，生成所述Java标准注释文档的接口文档。本发明实施例根据标签内容的上下级关系，生成Java包，实现了自动生成Java包；根据接口类型，生成协同空间页面，在实现自动生成协同空间页面的同时，提高了生成协同空间页面的准确性。根据协同空间，自动生成接口文档，提高了生成接口文档的效率。

附图说明

为了更清楚地说明本发明或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作一简单地介绍，显而易见地，下面描述中的附图是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是本发明提供的接口文档的生成方法的流程示意图之一；

图2是本发明提供的接口文档的生成方法的流程示意图之二；

图3是本发明提供的Java包的结构示意图；

图4是本发明提供的接口文档的生成装置的结构示意图；

图5是本发明提供的电子设备的结构示意图。

具体实施方式

为使本发明的目的、技术方案和优点更加清楚，下面将结合本发明中的附图，对本发明中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

需要说明的是，在本发明实施例的描述中，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

下面结合图1-图5描述本发明实施例所提供的接口文档的生成方法、装置及电子设备。

图1是本发明提供的接口文档的生成方法的流程示意图之一，如图1所示，包括但不限于以下步骤：

步骤100：识别Java标准注释文档中的标签内容，Java标准注释文档为对业务代码进行编译后的文档；

需要说明的是，本申请实施例的执行主体可以是服务器、计算机设备，例如手机、平板电脑、笔记本电脑、掌上电脑、车载电子设备、可穿戴设备、超级移动个人计算机(ultra-mobile personal computer，UMPC)、上网本或者个人数字助理(personal digitalassistant，PDA)等。

业务代码是开发人员针对某项业务开发的代码，例如，装车代码、卸车代码、发车代码等。接口文档为dubbo的接口文档。

标签内容在Java标准注释文档中具有规范和说明的作用。标签内容使Java标准注释文档更加完整、清晰和容易理解。标签内容可以为Java标准注释文档提供准确地描述和参考，帮助其他开发者更好地理解和使用业务代码。

如图2所示，通过代码托管与协作平台的Java接口文档(Javadoc-confluence)工具，解析Java标准注释文档中的标签内容。

步骤200：基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；

预先设置标签内容的上下级关系。将Java标准注释文档中具有上下级关系的标签内容组生成一个Java包(Java Package)。一个Java标准注释文档至少生成一个JavaPackage。

步骤300：基于Java包的接口类型，生成Java包的协同空间页面；

接口类型是根据接口的功能划分的。一种接口类型包含多个与其相关的Java包。协同空间页面(confluence page)的类型是依据接口类型划分的。不同的接口类型，对应不同的协同空间页面模板，进而生成不同类型的协同空间页面。一个Java Package生成一个协同空间页面。根据Java Package的接口类型，确定Java Package的协同空间页面模板，进而生成Java Package的协同空间页面。

步骤400：基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。

协同(confluence)空间是一种企业知识管理系统，用于帮助团队协作、共享知识以及创建文档、会议纪要、项目计划等。在协通空间内，可以创建页面、分享文件、发起讨论等，所有的内容都可以实时更新，并记录下历史版本。

接口定义了业务代码对外提供的功能和服务，包括输入参数、输出结果、异常处理等。接口文档用于描述业务代码对应的业务发生的条件。例如，业务代码为运单发车代码，接口文档包括运单发车业务需要的条件，例如，运单号、车牌、司机等。

如图2所示，将协同空间页面转换成协同空间文档，并通过confluence空间的表述性状态转移/应用程序编程内容(Representational State Transfer/ApplicationProgramming Interface for Content，rest/api/content)接口，将协同空间文档上传至confluence空间中。confluence空间根据上传的协同空间文档，生成接口文档。

进一步的，用户从协同空间中查看、下载接口文档。

本发明实施例提供的接口文档的生成方法，通过识别Java标准注释文档中的标签内容，Java标准注释文档为对业务代码进行编译后的文档；基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；基于Java包的接口类型，生成Java包的协同空间页面；基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。本发明实施例根据标签内容的上下级关系，生成Java包，实现了自动生成Java包；根据接口类型，生成协同空间页面，在实现自动生成协同空间页面的同时，提高了生成协同空间页面的准确性。根据协同空间，自动生成接口文档，提高了生成接口文档的效率。

基于上述实施例，基于Java包的接口类型，生成Java包的协同空间页面，包括：

步骤310：将Java包填充到接口类型对应的虚拟机模板中，以生成Java包的目标文件；

步骤320：将目标文件存入协同空间初始页面中，得到协同空间页面。

预先根据不同的接口类型设置对应的虚拟机模板。将Java Package根据接口类型进行分类。将Java Package填充到接口类型对应的虚拟机模板(Virtual MachineTemplate，VM)中，生成Java Package对应目标文件，目标文件包括超文本标记语言(Hypertext Markup Language，html)文件。

将目标文件中的数据填入协同空间初始页面的不同模块，得到最终的协同空间页面。

本发明实施例根据接口类型对应的虚拟机模板生成目标文件，进而生成协同空间页面，在实现自动生成协同空间页面的同时，提高了生成协同空间页面的准确性。

基于上述实施例，协同空间页面由标题名称和目标内容组成，将目标文件存入协同空间初始页面中，得到协同空间页面，包括：

步骤321：将目标文件的目标标题存入协同空间初始页面的标题模块，得到标题名称，标题名称包括父标题名称和子标题名称；

步骤322：将目标文件的待存入内容存入协同空间初始页面的内容模块，得到目标内容，目标内容包括父标题内容和子标题内容。

父标题名称为协同空间页面所属的功能类型的大类，例如，大数据服务。父标题内容包括与父标题名称关联的标签内容。子标题名称为协同空间页面所属的功能类型的小类，例如，接收大数据回传轨迹信息并保存到数据库。子标题内容包括与子标题名称关联的标签内容。

将目标文件的目标标题存入协同空间初始页面的标题模块，得到标题名称。例如，目标文件的目标标题为大数据服务和接收大数据回传轨迹信息并保存到数据库。则协同空间页面的标题名称为大数据服务—接收大数据回传轨迹信息并保存到数据库。

将目标文件的待存入内容存入协同空间初始页面的内容模块，得到协同空间页面的内容。将与父标题名称关联的标签内容，与子标题名称关联的标签内容存储协同空间初始页面的内容模块，得到协同空间页面的内容。协同空间页面的标题名称和内容组成协同空间页面。

本发明实施例通过确定协同空间页面的内容和标题名称，进而生成，在实现自动生成协同空间页面的同时，提高了生成协同空间页面的准确性。

基于上述实施例，基于协同空间和协同空间页面，生成Java标准注释文档的接口文档，包括：

步骤500：基于协同空间页面的过滤标识符，过滤掉不需要生成接口文档的协同空间页面；

步骤600：检查过滤后的协同空间页面的标题名称，并提示存在相同的标题名称；

步骤700：基于检查后的协同空间页面和协同空间，生成接口文档。

confluence page中包含过滤标识符，用于标记该confluence page是否需要生成接口文档。获取confluence page的过滤标识符，并过滤掉不需要生成接口文档的confluence page。

confluence page过滤完成之后，将confluence page分类存储在confluence空间的不同子目录(或者不同文件夹)中。检查confluence空间中的不同子目录中的confluencepage的标题名称。如果一个子目录中存在相同的标题名称，则提示文档重名。进一步的，用户根据提示修改confluence page的标题名称。

将检查后的confluence page上传至confluence空间。confluence空间根据confluence page生成接口文档。

本发明实施例通过对协同空间页面进行过滤和检查，去除了不需要生成接口文档的协同空间页面，也提高了协同空间页面内容的准确性，有利于提高基于协同空间页面生成接口文档的效率。

基于上述实施例，识别Java标准注释文档中的标签内容，包括：

步骤110：至少识别标签内容中的包标签、类标签、标注标签、接口标签、字段标签、类型标签、注释标签和注解标签；

步骤120：至少显示标注标签中的接口地址标签、特殊说明标签、作者标识标签和变更数据库表标签。

如图3所示，包(package)标签用于标识代码文件所属的包或命名空间，包标签可以帮助开发人员将业务代码的相关功能或类放在一起，并提供更好的代码组织和模块化。包标签能够确保业务代码被正确的编译、打包和发布。类(class)标签用于定义一个类或对象，用于描述一组具有相似属性和行为的对象。标注(tag)标签用于标记或注释代码，以提高代码可读性和可维护性。标注标签可以帮助开发人员更好地理解业务代码的含义和作用，并提供一些额外的信息和提示。接口(interface)标签用于定义接口或协议，以规定类或对象的行为和功能，其用于描述一组公共方法和属性的集合，以及实现这些方法和属性的具体类或对象。字段(field)标签用于注释类或对象的属性(字段)，以提供额外的信息和描述。类型(type)标签用于注释变量或者参数的数据类型。注释(comment)标签用于注释业务代码的目的、功能、实现细节或其他相关信息。接口地址标签，例如，统一资源标识符(Uniform Resource Identifier，uri)，用于指定网络接口的地址信息，以提供有关接口的访问地址的信息。特殊说明(special)标签用于对业务代码的部分内容进行特殊说明，以提供额外的信息或重要的注意事项。作者(author)标识标签用于指定代码、函数、类或方法的作者信息。变更数据库(tables)表标签用于标识可能变更的数据库表。

预先设置需要识别的标签内容，在解析Java标准注释文档中的标签内容时，识别该标签内容，标签内容至少包括包标签、类标签、标注标签、接口标签、字段标签、类型标签、注释标签和注解标签。

预先设置标注标签中的需要重点关注的标签内容，在解析Java标准注释文档中的标签内容时，解析并显示需要重点关注的标签内容，包括接口地址标签、特殊说明标签、作者标识标签、变更数据库表标签中的至少一种。

本发明实施例通过识别标签内容，解析Java标准注释文档，有利于实现自动生成接口文档，在提高生成接口文档的效率的同时，提高了生成的接口文档的准确性。

基于上述实施例，基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包，包括：

步骤210：将存在上下级关系的标签内容组成一个标签内容组；

步骤220：对每个标签内容组的标签内容按照上下级关系进行编排，得到至少一个Java包。

预先设置标签内容的上下级关系，例如，包标签是类标签和接口标签的上级，类标签的下级包括字段标签，字段标签的下级包括类型标签、注释标签、注解(annotation)标签等。

将存在上下级关系的标签内容组成一个标签内容组，例如，属于同一功能模块的标签内容存在上下级关系。Java标准注释文档包括多个功能模块，同一功能模块的标签内容具有上下级关系，同一功能模块的标签内容组成一个标签内容组。如图3所示，将属于同一功能模块的包标签、类标签、标注标签、接口标签、字段标签、类型标签、注释标签、注解标签、接口地址标签、特殊说明标签、作者标识标签、变更数据库表标签组成一个标签内容组。

对每个标签内容组中的标签内容根据预先设置的上下级关系进行编排，得到至少一个Java包。

本发明实施例根据上下级关系对标签内容进行编排，得到Java包，提高了Java包的准确性。

基于上述实施例，在识别Java标准注释文档中的标签内容之前，还包括：获取Java标准注释文档，获取Java标准注释文档，包括：

步骤130：调用代码托管与协作平台，以获取代码托管与协作平台识别的所述业务代码；

步骤140：基于代码托管与协作平台的持续集成工具，对业务代码进行编译，并生成Java标准注释文档。

代码托管与协作平台是提供代码托管和团队协作功能的平台。代码托管与协作平台允许开发者将代码存储在云端仓库中，并提供了一系列工具和功能，以促进多人协作、版本控制、代码审查和项目管理等活动。本申请的代码托管与协作平台包括gitlab平台，gitlab平台包括gitlab仓库，用于存储业务代码。gitlab平台包括持续集成(ContinuousIntegration，CI)工具，用于对业务代码进行编译。

如图2所示，用户编写业务代码，定义接口出入参对象，为接口和接口出入参编写java标准注释，表明接口的功能，以及接口出入参字段的含义，将编写完的业务代码提交至gitlab仓库。业务代码提交至gitlab仓库之后，会触发gitlab平台的CI工具进行工作，CI工具执行项目管理(maven)命令对提交的业务代码进行编译，编译生成Java标准注释(javadoc.xml)文档。

本发明实施例基于代码托管与协作平台及其持续集成工具，对业务代码进行自动编译，生成Java标准注释文档，提高了生成Java标准注释文档的准确性。

为了进一步对本申请实施例提供的接口文档的生成方法进行解析说明，具体通过以下实施例及图2进行说明。本发明实施例提供了一种接口文档的生成方法，包括：

(1)用户编写业务代码，将业务代码推送至gitlab平台的gitlab仓库。gitlab平台接收业务代码，并触发CI工具对业务代码进行编译，生成多个Java标准注释文档(例如，装车代码生成一个Java标准注释文档，卸货代码生成一个Java标准注释文档)，每个Java标准注释文档包括多个功能模块(例如，接收数据模块、分析数据模块、发送数据模块)，每个功能模块包括多个标注内容。

(2)gitlab平台的Java接口文档工具对每个Java标准注释文档中的标注内容进行解析。将属于一个功能模块的标注内容组成一个标注内容组。同一标注内容组中的标注内容根据其上下级关系生成一个Java包。

(3)将Java包根据接口类型(例如，数据接收接口、数据发送接口、数据分析接口)分类，将Java包填入其接口类型对应的虚拟机模板中，生成目标文件。将存入协同空间初始页面中，得到协同空间页面。每个Java包生成一个协同空间页面。

(4)对协同空间页面进行过滤和检查，以过滤不需要生成接口文档的协同空间页面，并更改名称重复的协同空间页面的标题名称。

(5)将检查后的协同空间页面上传至协同空间，协同空间将该协同空间页面转换成接口文档，并设置接口文档的查阅权限和下载权限。

(6)用户根据相应权限，通过协同空间页面查看接口文档。

本发明实施例提供的接口文档的生成方法，通过gitlab平台的CI工具，自动编译业务代码，并生成Java标准注释文档；充分利用Java原始的Java接口文档工具，对Java标准注释文档进行解析，实现了接口文档的自动生成。

本发明实施例还提供了一种接口文档的生成装置，如图4所示，图4是本发明提供的接口文档的生成装置的结构示意图。需要说明的是，本发明实施例提供的接口文档的生成装置，在具体运行时，可以执行上述任一实施例所述的接口文档的生成方法，对此本实施例不作赘述。参照图4，本发明的实施例提供了一种接口文档的生成装置，包括：

识别模块401，用于识别Java标准注释文档中的标签内容，Java标准注释文档为对业务代码进行编译后的文档；

Java包生成模块402，用于基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；

协同空间页面生成模块403，用于基于Java包的接口类型，生成Java包的协同空间页面；

接口文档生成模块404，用于基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。

本发明实施例提供的接口文档的生成装置，通过识别Java标准注释文档中的标签内容，Java标准注释文档为对业务代码进行编译后的文档；基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；基于Java包的接口类型，生成Java包的协同空间页面；基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。本发明实施例根据标签内容的上下级关系，生成Java包，实现了自动生成Java包；根据接口类型，生成协同空间页面，在实现自动生成协同空间页面的同时，提高了生成协同空间页面的准确性。根据协同空间，自动生成接口文档，提高了生成接口文档的效率。

在一个实施例中，协同空间页面生成模块403用于：将Java包填充到接口类型对应的虚拟机模板中，以生成Java包的目标文件；将目标文件存入协同空间初始页面中，得到协同空间页面。

在一个实施例中，协同空间页面由标题名称和目标内容组成，协同空间页面生成模块403用于：将目标文件的目标标题存入协同空间初始页面的标题模块，得到标题名称，标题名称包括父标题名称和子标题名称；将目标文件的待存入内容存入协同空间初始页面的内容模块，得到目标内容，目标内容包括父标题内容和子标题内容。

在一个实施例中，接口文档生成模块404用于：基于协同空间页面的过滤标识符，过滤掉不需要生成接口文档的协同空间页面；检查过滤后的协同空间页面的标题名称，并提示存在相同的标题名称；基于检查后的协同空间页面和协同空间，生成接口文档。

在一个实施例中，识别模块401用于：至少识别标签内容中的包标签、类标签、标注标签、接口标签、字段标签、类型标签、注释标签和注解标签；至少显示标注标签中的接口地址标签、特殊说明标签、作者标识标签和变更数据库表标签。

在一个实施例中，Java包生成模块402用于：将存在上下级关系的标签内容组成一个标签内容组；对每个标签内容组的标签内容按照上下级关系进行编排，得到Java包。

在一个实施例中，在识别Java标准注释文档中的标签内容之前，还包括：获取Java标准注释文档，识别模块401用于：获取Java标准注释文档，包括：调用代码托管与协作平台，以获取代码托管与协作平台识别的业务代码；基于代码托管与协作平台的持续集成工具，对业务代码进行编译，并生成Java标准注释文档。

图5是本发明提供的电子设备的结构示意图，如图5所示，该电子设备可以包括：处理器(processor)510、通信接口(Communications Interface)520、存储器(memory)530和通信总线540，其中，处理器510，通信接口520，存储器530通过通信总线540完成相互间的通信。处理器510可以调用存储器530中的逻辑指令，以执行接口文档的生成方法，该方法包括：识别Java标准注释文档中的标签内容，Java标准注释文档为对业务代码进行编译后的文档；基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；基于Java包的接口类型，生成Java包的协同空间页面；基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。

此外，上述的存储器530中的逻辑指令可以通过软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本发明各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(ROM，Read-Only Memory)、随机存取存储器(RAM，Random Access Memory)、磁碟或者光盘等各种可以存储程序代码的介质。

另一方面，本发明还提供一种计算机程序产品，所述计算机程序产品包括存储在非暂态计算机可读存储介质上的计算机程序，所述计算机程序包括程序指令，当所述程序指令被计算机执行时，计算机能够执行上述各实施例所提供的接口文档的生成方法，该方法包括：识别Java标准注释文档中的标签内容，Java标准注释文档为对业务代码进行编译后的文档；基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；基于Java包的接口类型，生成Java包的协同空间页面；基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。

又一方面，本发明还提供一种非暂态计算机可读存储介质，其上存储有计算机程序，该计算机程序被处理器执行时实现以执行上述各实施例提供的接口文档的生成方法，该方法包括：识别Java标准注释文档中的标签内容，Java标准注释文档为对业务代码进行编译后的文档；基于标签内容的上下级关系，构建Java标准注释文档的至少一个Java包；基于Java包的接口类型，生成Java包的协同空间页面；基于协同空间和协同空间页面，生成Java标准注释文档的接口文档。

以上所描述的装置实施例仅仅是示意性的，其中所述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部模块来实现本实施例方案的目的。本领域普通技术人员在不付出创造性的劳动的情况下，即可以理解并实施。

通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到各实施方式可借助软件加必需的通用硬件平台的方式来实现，当然也可以通过硬件。基于这样的理解，上述技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品可以存储在计算机可读存储介质中，如ROM/RAM、磁碟、光盘等，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行各个实施例或者实施例的某些部分所述的方法。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims (10)

1.一种接口文档的生成方法，其特征在于，包括：

识别Java标准注释文档中的标签内容，所述Java标准注释文档为对业务代码进行编译后的文档；

基于所述标签内容的上下级关系，构建所述Java标准注释文档的至少一个Java包；

基于所述Java包的接口类型，生成所述Java包的协同空间页面；

基于协同空间和所述协同空间页面，生成所述Java标准注释文档的接口文档。

2.根据权利要求1所述的接口文档的生成方法，其特征在于，所述基于所述Java包的接口类型，生成所述Java包的协同空间页面，包括：

将所述Java包填充到所述接口类型对应的虚拟机模板中，以生成所述Java包的目标文件；

将所述目标文件存入协同空间初始页面中，得到所述协同空间页面。

3.根据权利要求2所述的接口文档的生成方法，其特征在于，所述协同空间页面由标题名称和目标内容组成，所述将所述目标文件存入协同空间初始页面中，得到所述协同空间页面，包括：

将所述目标文件的目标标题存入所述协同空间初始页面的标题模块，得到所述标题名称，所述标题名称包括父标题名称和子标题名称；

将所述目标文件的待存入内容存入所述协同空间初始页面的内容模块，得到所述目标内容，所述目标内容包括父标题内容和子标题内容。

4.根据权利要求1所述的接口文档的生成方法，其特征在于，所述基于协同空间和所述协同空间页面，生成所述Java标准注释文档的接口文档，包括：

基于所述协同空间页面的过滤标识符，过滤掉不需要生成所述接口文档的所述协同空间页面；

检查过滤后的所述协同空间页面的标题名称，并提示存在相同的所述标题名称；

基于检查后的所述协同空间页面和所述协同空间，生成所述接口文档。

5.根据权利要求1所述的接口文档的生成方法，其特征在于，所述识别Java标准注释文档中的标签内容，包括：

至少识别所述标签内容中的包标签、类标签、标注标签、接口标签、字段标签、类型标签、注释标签和注解标签；

至少显示所述标注标签中的接口地址标签、特殊说明标签、作者标识标签和变更数据库表标签。

6.根据权利要求1所述的接口文档的生成方法，其特征在于，所述基于所述标签内容的上下级关系，构建所述Java标准注释文档的至少一个Java包，包括：

将存在所述上下级关系的所述标签内容组成一个标签内容组；

对每个所述标签内容组的所述标签内容按照所述上下级关系进行编排，得到所述Java包。

7.根据权利要求1所述的接口文档的生成方法，其特征在于，所述在识别Java标准注释文档中的标签内容之前，还包括：获取所述Java标准注释文档，所述获取所述Java标准注释文档，包括：

调用代码托管与协作平台，以获取代码托管与协作平台识别的所述业务代码；

基于所述代码托管与协作平台的持续集成工具，对所述业务代码进行编译，并生成所述Java标准注释文档。

8.一种接口文档的生成装置，其特征在于，包括：

识别模块，用于识别Java标准注释文档中的标签内容，所述Java标准注释文档为对业务代码进行编译后的文档；

Java包生成模块，用于基于所述标签内容的上下级关系，构建所述Java标准注释文档的至少一个Java包；

协同空间页面生成模块，用于基于所述Java包的接口类型，生成所述Java包的协同空间页面；

接口文档生成模块，用于将所述协同空间页面上传至协同空间，并基于协同空间和所述协同空间页面，生成所述Java标准注释文档的接口文档。

9.一种电子设备，包括存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如权利要求1至7任一项所述接口文档的生成方法的步骤。

10.一种非暂态计算机可读存储介质，其上存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现如权利要求1至7任一项所述接口文档的生成方法的步骤。