CN109901934B - 生成接口帮助文档的方法和装置 - Google Patents

Abstract

本发明公开了生成接口帮助文档的方法和装置，涉及计算机技术领域。该方法的一具体实施方式包括：根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象；基于接口实现类对象生成待调用接口对应的接口帮助文档。该实施方式能够仅针对待调用接口生成接口帮助文档；生成接口帮助文档的过程方便、快捷；且生成的接口帮助文档可以在突出重点的同时保护内部程序。

Description

生成接口帮助文档的方法和装置

技术领域

本发明涉及计算机技术领域，尤其涉及一种生成接口帮助文档的方法和装置。

背景技术

随着企业业务的快速发展，企业的业务线内容也在不断增加和完善。一个完整的业务线由多个相关应用系统组成，例如某个企业的业务线包括会计系统、供应链管理系统和人员管理系统，同一个业务线下的各应用系统之间需要通过调用接口的方式进行信息传递和交互，因此，接口的定义信息需要全方面的展示给调用方。

通常一个应用系统需要为多个其它应用系统提供接口，且针对不同业务线的同一种业务操作需要向所在业务线的其它应用系统提供唯一的接口，但是，每条业务线针对同一种业务操作的业务逻辑会有不同程度的差别，因此，需要提供接口的应用系统对接口的参数做出明确的标识，例如：哪些是必填参数、哪些是辅助参数或哪些是针对某种业务线必填而其他业务线为辅助的参数。

现有技术是在编写应用系统过程中，使用一套特定标签在应用系统的源代码中做注释，例如：标签@author表示作者、标签@exception表示异常类名等，在程序编写完成后，从源代码中获取所有的注释信息，基于注释信息生成接口帮助文档，该接口帮助文档用于介绍接口的参数、使用方法和功能。

在实现本发明过程中，发明人发现现有技术中至少存在如下问题：

1.无法做到针对性的生成接口帮助文档，应用系统对外提供的接口只是整个应用系统中的一部分，而其它部分可能是用于内部的实现，如果生成整个应用系统的接口帮助文档，不仅对外暴露了接口提供方的内部结构也对接口调用方造成干扰；

2.需要大量的人力进行干预且操作复杂，随着业务线的不断增加或完善，接口也会相应的改变或者新增接口，为避免接口帮助文档与接口之间不匹配，每当接口有变更时，都需要重新生成整个应用系统的接口帮助文档。

发明内容

有鉴于此，本发明实施例提供一种生成接口帮助文档的方法和装置，能够仅针对待调用接口生成接口帮助文档；生成接口帮助文档的过程方便、快捷；且生成的接口帮助文档可以在突出重点的同时保护内部程序。

为实现上述目的，根据本发明实施例的一个方面，提供了一种生成接口帮助文档的方法。

本发明实施例的一种生成接口帮助文档的方法包括：根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象；基于所述接口实现类对象生成所述待调用接口对应的接口帮助文档。

可选地，根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象之前还包括：在所述接口提供方的待调用接口代码中为所述待调用接口添加所述预设标识；执行所述待调用接口代码生成上下文环境；其中，所述预设标识包括接口注解和方法注解。

可选地，根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象之前还包括：监听所述接口提供方的代码库；当监听到所述代码库中发生特定操作时，从所述代码库中获取所述接口提供方的所述上下文环境。

可选地，基于所述接口实现类对象生成所述待调用接口对应的接口帮助文档包括：解析所述接口实现类对象得到所述待调用接口的注释信息；根据所述注释信息生成所述待调用接口对应的接口帮助文档。

可选地，所述注释信息包括方法注释信息和属性注释信息；以及解析所述接口实现类对象得到所述待调用接口的注释信息包括：从所述接口实现类对象中得到所述待调用接口的名称和路径；调用方法解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的方法注释信息；以及调用属性解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的属性注释信息。

为实现上述目的，根据本发明实施例的另一方面，提供了一种生成接口帮助文档的装置。

本发明实施例的一种生成接口帮助文档的装置包括：获取模块，用于根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象；生成模块，用于基于所述接口实现类对象生成所述待调用接口对应的接口帮助文档。

可选地，所述装置还包括：添加模块，用于在所述接口提供方的待调用接口代码中为所述待调用接口添加所述预设标识；执行所述待调用接口代码生成上下文环境；其中，所述预设标识包括接口注解和方法注解。

可选地，所述装置还包括：监听模块，用于监听所述接口提供方的代码库；当监听到所述代码库中发生特定操作时，从所述代码库中获取所述接口提供方的所述上下文环境。

可选地，所述生成模块具体用于：解析所述接口实现类对象得到所述待调用接口的注释信息；根据所述注释信息生成所述待调用接口对应的接口帮助文档。

可选地，所述注释信息包括方法注释信息和属性注释信息；以及所述生成模块还用于：从所述接口实现类对象中得到所述待调用接口的名称和路径；调用方法解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的方法注释信息；以及调用属性解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的属性注释信息。

为实现上述目的，根据本发明实施例的又一方面，提供了一种生成接口帮助文档的电子设备。

本发明实施例的一种生成接口帮助文档的电子设备包括：一个或多个处理器；存储装置，用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现本发明实施例的一种生成接口帮助文档的方法。

为实现上述目的，根据本发明实施例的再一方面，提供了一种计算机可读存储介质。

本发明实施例的一种计算机可读存储介质，其上存储有计算机程序，所述程序被处理器执行时实现本发明实施例的一种生成接口帮助文档的方法。

上述发明中的一个实施例具有如下优点或有益效果：因为采用预设标识对待调用接口进行标记，在生成接口帮助文档时，根据预设标识从接口提供方的上下文环境中仅获取待调用接口所对应的接口实现类对象，基于接口实现类对象生成与待调用接口对应的接口帮助文档的技术手段，所以克服了现有技术只能为整个应用系统生成接口帮助文档，无法做到针对性的生成接口帮助文档；同时，在生成接口帮助文档的过程中需要大量的人力进行干预且操作复杂的技术问题，进而达到仅针对待调用接口生成接口帮助文档；生成接口帮助文档的过程方便、快捷；且生成的接口帮助文档可以在突出重点的同时保护内部程序的技术效果。

上述的非惯用的可选方式所具有的进一步效果将在下文中结合具体实施方式加以说明。

附图说明

附图用于更好地理解本发明，不构成对本发明的不当限定。其中：

图1是根据本发明实施例的生成接口帮助文档的方法的主要步骤的示意图；

图2是根据本发明实施例的生成接口帮助文档的装置的主要模块的示意图；

图3是根据本发明实施例的生成接口帮助文档的方法的实现框架的示意图；

图4是根据本发明实施例的生成接口帮助文档的方法的时序示意图；

图5是本发明实施例可以应用于其中的示例性系统架构图；

图6是适于用来实现本发明实施例的终端设备或服务器的计算机系统的结构示意图。

具体实施方式

以下结合附图对本发明的示范性实施例做出说明，其中包括本发明实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本发明的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知功能和结构的描述。

图1是根据本发明实施例的生成接口帮助文档的方法的主要步骤的示意图。

如图1所示，本发明实施例的一种生成接口帮助文档的方法主要包括以下步骤：

步骤S101：根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象。

为了实现针对性的生成接口帮助文档，以及生成接口帮助文档的过程中减少人力干预，本发明实施例仅为用于调用的接口生成接口帮助文档，在生成接口帮助文档时，从接口提供方的上下文环境中仅获取用于调用的待调用接口所对应的接口实现类对象。其中，上下文环境是指可执行代码的对象的运行环境，在执行代码的过程中可以生成上下文环境，从而从上下文环境中获取变量、函数和数据。

需要说明的是，本发明实施例可以采用注释或注解等作为预设标识，对用于调用的待调用接口进行标记，即待调用接口为携带有预设标识的接口。

为了准确地获取待调用接口的接口实现类对象，可以通过预先设定的预设标识对待调用接口进行标记，该预设标识可以是接口注解，也可以是方法注解。在本发明实施例中，根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象之前还包括：在接口提供方的待调用接口代码中为待调用接口添加预设标识；执行待调用接口代码生成上下文环境；其中，预设标识包括接口注解和方法注解。

在本发明实施例中，根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象之前还包括：监听接口提供方的代码库；当监听到代码库中发生特定操作时，从代码库中获取接口提供方的上下文环境。

其中，特定操作可以是主干代码合并操作；主干代码合并操作是指对当前代码库主干版本的升级，将修改代码推送到唯一指定允许发布的分支代码(即主干代码)上。应用系统的代码库通常使用代码管理工具进行管理，例如分布式版本控制系统(Git)、分支版本控制系统(SVN)和代码版本控制软件(CVS)等，对于何时发生特定操作可以通过对接口提供方的代码库进行监听实现，例如使用服务端挂钩对接口提供方的代码库进行监听，服务端挂钩是一种Git提供的用于对主干推送操作所修改的引用或文件进行访问控制的工具。

步骤S102：基于接口实现类对象生成待调用接口对应的接口帮助文档。

为了生成仅针对待调用接口的接口帮助文档，本发明实施例可以根据待调用接口的接口实现类对象来为待调用接口生成接口帮助文档。仅生成对应于待调用接口的接口帮助文档，能够在接口帮助文档的维护等方面减少人力、时间的消耗；且生成的接口帮助文档可以在突出重点的同时保护内部程序。

需要说明的是，接口帮助文档的格式可以是超文本标记语言文件(HTML文件)或网页版文档。

在本发明实施例中，本步骤可以通过解析接口实现类对象得到待调用接口的注释信息；根据注释信息生成待调用接口对应的接口帮助文档实现。为了在该接口帮助文档中将待调用接口的参数和是否必填等信息明确的体现出来，可以通过解析待调用接口对应的接口实现类对象来获得待调用接口的注释信息，从而与待调用接口对应的生成接口帮助文档，该注释信息可以将接口提供方对外提供的待调用接口的参数和是否必填等信息完整、精确的体现出来。

可以通过分别解析组成待调用接口的方法以及解析接口实现类对象的属性来分别得到方法注释信息和属性注释信息，从而将待调用接口的注释信息完整的解析出来，以生成待调用接口的接口帮助文档。在本发明实施例中，注释信息包括方法注释信息和属性注释信息；则解析接口实现类对象得到待调用接口的注释信息可以通过从接口实现类对象中得到待调用接口的名称和路径；调用方法解析工具根据待调用接口的名称和路径对接口实现类对象进行解析得到待调用接口的方法注释信息；以及调用属性解析工具根据待调用接口的名称和路径对接口实现类对象进行解析得到待调用接口的属性注释信息实现。

根据本发明实施例的生成接口帮助文档的方法可以看出，因为采用预设标识对待调用接口进行标记，在生成接口帮助文档时，根据预设标识从接口提供方的上下文环境中仅获取待调用接口所对应的接口实现类对象，基于接口实现类对象生成与待调用接口对应的接口帮助文档的技术手段，所以克服了现有技术只能为整个应用系统生成接口帮助文档，无法做到针对性的生成接口帮助文档；同时，在生成接口帮助文档的过程中需要大量的人力进行干预且操作复杂的技术问题，进而达到仅针对待调用接口生成接口帮助文档；生成接口帮助文档的过程方便、快捷；且生成的接口帮助文档可以在突出重点的同时保护内部程序的技术效果。

图2是根据本发明实施例的生成接口帮助文档的装置的主要模块的示意图。

如图2所示，本发明实施例的一种生成接口帮助文档的装置200包括：获取模块201和生成模块202。

其中，

获取模块201，用于根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象；

生成模块202，用于基于所述接口实现类对象生成所述待调用接口对应的接口帮助文档。

在本发明实施例中，所述装置还包括：添加模块，用于在所述接口提供方的待调用接口代码中为所述待调用接口添加所述预设标识；执行所述待调用接口代码生成上下文环境；其中，所述预设标识包括接口注解和方法注解。

在本发明实施例中，所述装置还包括：监听模块，用于监听所述接口提供方的代码库；当监听到所述代码库中发生特定操作时，从所述代码库中获取所述接口提供方的所述上下文环境。

在本发明实施例中，所述生成模块202具体用于：解析所述接口实现类对象得到所述待调用接口的注释信息；根据所述注释信息生成所述待调用接口对应的接口帮助文档。

此外，所述注释信息包括方法注释信息和属性注释信息；以及所述生成模块202还用于：从所述接口实现类对象中得到所述待调用接口的名称和路径；调用方法解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的方法注释信息；以及调用属性解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的属性注释信息。

根据本发明实施例的生成接口帮助文档的装置可以看出，因为采用预设标识对待调用接口进行标记，在生成接口帮助文档时，根据预设标识从接口提供方的上下文环境中仅获取待调用接口所对应的接口实现类对象，基于接口实现类对象生成与待调用接口对应的接口帮助文档的技术手段，所以克服了现有技术只能为整个应用系统生成接口帮助文档，无法做到针对性的生成接口帮助文档；同时，在生成接口帮助文档的过程中需要大量的人力进行干预且操作复杂的技术问题，进而达到仅针对待调用接口生成接口帮助文档；生成接口帮助文档的过程方便、快捷；且生成的接口帮助文档可以在突出重点的同时保护内部程序的技术效果。

图3是根据本发明实施例的生成接口帮助文档的方法的实现框架的示意图。

如图3所示，为实现本发明实施例的生成接口帮助文档的方法，可以构建由触发组件、生成主程序、注释解析组件和注解组件组成的实现框架来执行生成接口帮助文档的方法。且本发明实施例采用特定注解作为预设标识；以及将主干代码合并操作作为特定操作。

其中，触发组件即为生成接口帮助文档的指令部门，触发后调用文档生成主程序获取携带有特定注解的接口实现类对象，解析接口实现类对象得到待调用接口的名称和地址，利用注释解析组件基于待调用接口的名称和地址获取接口实现类对象的注释信息，根据该注释信息生成接口帮助文档。需要说明的是，可以将接口帮助文档以某种格式上传或者将接口帮助文档中的每个HTML编译到特定地址的页面中，生成网页版文档。

具体地，各功能组件的作用如下：

一、注解组件

注解组件可以用于定义特定注解，例如通过“@interface”声明是自定义的注解；以及将定义的注解写入待调用接口的代码中。本发明实施例中，可以将“@Target”和“@Retention”定义为特定注解，以对待调用接口的接口实现类对象进行标记，具体使用如下：

接口注解，声明前标注特定注解及参数为“@Target(ElementType.Type)”表示注解是标注在待调用接口的接口实现类对象上的，特定注解及参数为“@Retention(RetentionPolicy.RUNTIME)”表示注解仅在运行时有效。

方法注解，声明前标注元注解特定参数为“@Target(ElementType.METHOD)”表示注解是标注在待调用接口的方法上的，同时也需要标注@Retention(RetentionPolicy.RUNTIME)。

二、触发组件

触发组件可以用于监听接口提供方的代码库以及调用文档生成主程序。具体地，当触发组件监听到接口提供方的代码库中发生的主干代码合并操作时，调用文档生成主程序生成程序准备为待调用接口生成接口帮助文档。

通常代码库使用SVN、CVS或Git等代码管理工具进行管理。以Git为例，可以使用服务端挂钩(post-receive)对接口提供方的代码库进行监听，当监听到特定操作时调用文档生成主程序进行后续操作。其中，服务端挂钩是一种Git提供的用于对主干推送操作所修改的引用或文件进行访问控制的工具。

三、文档生成主程序

文档生成主程序是用于承接其它三个功能组件的总控程序，当接收到触发组件指令生成接口帮助文档开始，文档生成主程序先获取接口提供方的上下文环境，再解析上下文环境中携带有特定注解的接口实现类对象得到待调用接口的名称和路径。将待调用接口的名称和路径发送给注释解析组件。

四、注释解析组件

注释解析组件用于对接口实现类对象进行解析，从而将待调用接口的注释信息完整的解析出来，其中，对接口实现类对象的解析主要包括方法注释解析和属性注释解析两方面，具体地：

关于方法注释解析

可以调用方法注释解析工具对接口实现类对象进行解析。通常方法注释以“/**…*/”的形式在代码中进行标记，主要用于接口及接口的方法。可以使用调用程序“Runtime.getRunTime().exec()”来获得方法注释信息，还可以使用正则表达式匹配以“/**”开头和“*/”结尾的行(即为注释行)，从而获得方法注释信息。

关于属性注释解析

可以调用属性注释解析工具对接口实现类对象进行解析。对于属性注释的解析主要有单行属性注释解析和多行属性注释解析两种方式：

单行注释以“//”的形式在代码中进行标记，主要用于对象的属性中，简单的说明属性的含义。单行注释的解析方式是：读取接口实现类对象的代码文件，使用正则表达式匹配以“//”开头的行作为属性注释，从而获得单行属性注释信息；

多行注释以“/*…*/”的形式在代码中进行标记，多行注释主要用于对象的属性中，简单的说明属性的含义。同样可以使用正则表达式匹配“/*”开头和“*/”结尾的行作为属性注释，从而获得多行属性注释信息。

此外，利用注释解析组件对接口实现类对象进行解析可以采用以下步骤：

1、使用方法注释解析工具，将接口实现类对象先解析成HTML文件；

2、识别接口实现类对象中注释类型为单行注释或多行注释，并调用对应的属性注释解析工具进行解析；

3、读取已生成的HTML文件，把利用属性注释解析工具得到的属性注释信息写入HTML文件，从而生成HTML文件形式的接口帮助文档。

以上是对各个功能组件的介绍，现结合图4所示的本发明实施例的生成接口帮助文档的方法的时序示意图，对各功能组件之间的关联以及如何生成接口帮助文档进行说明，且同样采用特定注解作为预设标识；以及将主干代码合并操作作为特定操作。

如图4所示，在本发明实施例中，可以利用注解组件预先定义特定注解，并在生成接口帮助文档之前将该特定注解写入到接口提供方的待调用接口代码中，例如可以在编写接口提供方的待调用接口代码时。

利用触发组件监听接口提供方的代码库，当监听到待调用接口的代码库发生主干代码合并操作时，需要为该待调用接口生成接口帮助文档，此时触发组件可以向文档生成主程序发送生成接口帮助文档指令，从而调用文档生成主程序。

文档生成主程序从接口提供方的上下文环境中获取待调用接口的接口实现类对象，文档生成主程序将该接口实现类对象发送给注释解析组件。

注释解析组件解析该接口实现类对象以得到与待调用接口对应的注释信息，根据该注释信息生成与待调用接口对应的接口文档并返回给文档生成主程序。

为了进一步阐述本发明实施例的技术思想，现结合具体的应用场景，对本发明实施例的技术方案进行说明。

首先，定义预设标识：

在本发明实施例中，将接口注解“CreateFileClass”和方法注解“CreateFileMethod”作为预设标识。

其次，将特定注解添加到待调用接口代码中：

即在与待调用接口对应的接口实现类对象上添加注解@CreateFileClass，在待调用接口的方法上标注注解@CreateFileMethod。

再次，监听接口提供方的代码库：

当监听到接口提供方的代码库中发生主干代码合并操作时，通过解析上下文环境中标注为@CreateFileClass的接口实现类对象和标注@CreateFileMethod的方法得到待调用接口的名称和地址等信息。

然后，基于待调用接口的名称和地址获取接口实现类对象，并调用方法解析工具和属性解析工具对接口实现类对象进行解析得到待调用接口的注释信息。

最后，根据待调用接口的注释信息为待调用接口生成接口帮助文档。

图5示出了可以应用本发明实施例的生成接口帮助文档的方法或生成接口帮助文档的装置的示例性系统架构500。

如图5所示，系统架构500可以包括终端设备501、502、503，网络504和服务器505。网络504用以在终端设备501、502、503和服务器505之间提供通信链路的介质。网络504可以包括各种连接类型，例如有线、无线通信链路或者光纤电缆等等。

用户可以使用终端设备501、502、503通过网络504与服务器505交互，以接收或发送消息等。终端设备501、502、503上可以安装有各种通讯客户端应用，例如购物类应用、网页浏览器应用、搜索类应用、即时通信工具、邮箱客户端、社交平台软件等。

终端设备501、502、503可以是具有显示屏并且支持网页浏览的各种电子设备，包括但不限于智能手机、平板电脑、膝上型便携计算机和台式计算机等等。

服务器505可以是提供各种服务的服务器，例如对用户利用终端设备501、502、503所浏览的购物类网站提供支持的后台管理服务器。后台管理服务器可以对接收到的产品信息查询请求等数据进行分析等处理，并将处理结果反馈给终端设备。

需要说明的是，本发明实施例所提供的生成接口帮助文档的方法一般由服务器505执行，相应地，生成接口帮助文档的装置一般设置于服务器505中。

应该理解，图5中的终端设备、网络和服务器的数目仅仅是示意性的。根据实现需要，可以具有任意数目的终端设备、网络和服务器。

下面参考图6，其示出了适于用来实现本发明实施例的终端设备的计算机系统600的结构示意图。图6示出的终端设备仅仅是一个示例，不应对本发明实施例的功能和使用范围带来任何限制。

如图6所示，计算机系统600包括中央处理单元(CPU)601，其可以根据存储在只读存储器(ROM)602中的程序或者从存储部分608加载到随机访问存储器(RAM)603中的程序而执行各种适当的动作和处理。在RAM 603中，还存储有系统600操作所需的各种程序和数据。CPU 601、ROM 602以及RAM 603通过总线604彼此相连。输入/输出(I/O)接口605也连接至总线604。

以下部件连接至I/O接口605：包括键盘、鼠标等的输入部分606；包括诸如阴极射线管(CRT)、液晶显示器(LCD)等以及扬声器等的输出部分607；包括硬盘等的存储部分608；以及包括诸如LAN卡、调制解调器等的网络接口卡的通信部分609。通信部分609经由诸如因特网的网络执行通信处理。驱动器610也根据需要连接至I/O接口605。可拆卸介质611，诸如磁盘、光盘、磁光盘、半导体存储器等等，根据需要安装在驱动器610上，以便于从其上读出的计算机程序根据需要被安装入存储部分608。

特别地，根据本发明公开的实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本发明公开的实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的实施例中，该计算机程序可以通过通信部分609从网络上被下载和安装，和/或从可拆卸介质611被安装。在该计算机程序被中央处理单元(CPU)601执行时，执行本发明的系统中限定的上述功能。

需要说明的是，本发明所示的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本发明中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本发明中，计算机可读的信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读的信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：无线、电线、光缆、RF等等，或者上述的任意合适的组合。

附图中的流程图和框图，图示了按照本发明各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，上述模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图或流程图中的每个方框、以及框图或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本发明实施例中所涉及到的模块可以通过软件的方式实现，也可以通过硬件的方式来实现。所描述的模块也可以设置在处理器中，例如，可以描述为：一种处理器包括获取模块和生成模块。其中，这些模块的名称在某种情况下并不构成对该模块本身的限定，例如，获取模块还可以被描述为“根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象的模块”。

作为另一方面，本发明还提供了一种计算机可读介质，该计算机可读介质可以是上述实施例中描述的设备中所包含的；也可以是单独存在，而未装配入该设备中。上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被一个该设备执行时，使得该设备包括：步骤S101：根据预设标识从接口提供方的上下文环境中获取待调用接口的接口实现类对象；步骤S102：基于接口实现类对象生成待调用接口对应的接口帮助文档。

根据本发明实施例的技术方案，因为采用预设标识对待调用接口进行标记，在生成接口帮助文档时，根据预设标识从接口提供方的上下文环境中仅获取待调用接口所对应的接口实现类对象，基于接口实现类对象生成与待调用接口对应的接口帮助文档的技术手段，所以克服了现有技术只能为整个应用系统生成接口帮助文档，无法做到针对性的生成接口帮助文档；同时，在生成接口帮助文档的过程中需要大量的人力进行干预且操作复杂的技术问题，进而达到仅针对待调用接口生成接口帮助文档；生成接口帮助文档的过程方便、快捷；且生成的接口帮助文档可以在突出重点的同时保护内部程序的技术效果。

上述具体实施方式，并不构成对本发明保护范围的限制。本领域技术人员应该明白的是，取决于设计要求和其他因素，可以发生各种各样的修改、组合、子组合和替代。任何在本发明的精神和原则之内所作的修改、等同替换和改进等，均应包含在本发明保护范围之内。

Claims (10)

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

根据预设标识从接口提供方的上下文环境中仅获取待调用接口的接口实现类对象；其中，所述待调用接口为应用系统对外提供的接口；

基于所述接口实现类对象生成所述待调用接口对应的接口帮助文档；

根据预设标识从接口提供方的上下文环境中仅获取待调用接口的接口实现类对象之前还包括：

监听所述接口提供方的代码库；

当监听到所述代码库中发生特定操作时，从所述代码库中获取所述接口提供方的所述上下文环境；其中，所述特定操作是主干代码合并操作；

根据预设标识从接口提供方的上下文环境中仅获取待调用接口的接口实现类对象之前还包括：

在所述接口提供方的待调用接口代码中为所述待调用接口添加所述预设标识；其中，所述预设标识包括接口注解和方法注解。

2.根据权利要求1所述的方法，其特征在于，根据预设标识从接口提供方的上下文环境中仅获取待调用接口的接口实现类对象之前还包括：

执行所述待调用接口代码生成上下文环境。

3.根据权利要求1所述的方法，其特征在于，基于所述接口实现类对象生成所述待调用接口对应的接口帮助文档包括：

解析所述接口实现类对象得到所述待调用接口的注释信息；

根据所述注释信息生成所述待调用接口对应的接口帮助文档。

4.根据权利要求3所述的方法，其特征在于，所述注释信息包括方法注释信息和属性注释信息；以及解析所述接口实现类对象得到所述待调用接口的注释信息包括：

从所述接口实现类对象中得到所述待调用接口的名称和路径；

调用方法解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的方法注释信息；以及

调用属性解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的属性注释信息。

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

获取模块，用于根据预设标识从接口提供方的上下文环境中仅获取待调用接口的接口实现类对象；其中，所述待调用接口为应用系统对外提供的接口；

生成模块，用于基于所述接口实现类对象生成所述待调用接口对应的接口帮助文档；

所述装置还包括：

监听模块，用于监听所述接口提供方的代码库；

当监听到所述代码库中发生特定操作时，从所述代码库中获取所述接口提供方的所述上下文环境；其中，所述特定操作是主干代码合并操作；

所述装置还包括：

添加模块，用于在所述接口提供方的待调用接口代码中为所述待调用接口添加所述预设标识；其中，所述预设标识包括接口注解和方法注解。

6.根据权利要求5所述的装置，其特征在于，所述添加模块还用于执行所述待调用接口代码生成上下文环境。

7.根据权利要求5所述的装置，其特征在于，所述生成模块具体用于：

解析所述接口实现类对象得到所述待调用接口的注释信息；

根据所述注释信息生成所述待调用接口对应的接口帮助文档。

8.根据权利要求7所述的装置，其特征在于，所述注释信息包括方法注释信息和属性注释信息；以及所述生成模块还用于：

从所述接口实现类对象中得到所述待调用接口的名称和路径；

调用方法解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的方法注释信息；以及

调用属性解析工具根据所述待调用接口的名称和路径对所述接口实现类对象进行解析得到所述待调用接口的属性注释信息。

9.一种生成接口帮助文档的电子设备，其特征在于，包括：

一个或多个处理器；

存储装置，用于存储一个或多个程序，

当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现如权利要求1-4中任一所述的方法。

10.一种计算机可读介质，其上存储有计算机程序，其特征在于，所述程序被处理器执行时实现如权利要求1-4中任一所述的方法。

Images