[发明专利]一种接口文档生成方法及终端设备

说明书

技术领域

本发明属于计算机技术领域，尤其涉及一种接口文档生成方法及终端设备。

背景技术

随着计算机技术的不断发展，软件系统的复杂度越来越高，代码量也越来越大，常用的软件系统动辄需要几十万，甚至上百万行的代码，因此往往需要许多名开发人员共同协作进行开发，但不同的开发人员之间的编程风格相差较大，某一开发人员编写的代码往往难以被另一开发人员理解。因此，为了便于其他开发人员了解其代码内容，开发人员除了编写代码之外，还需要花费大量的时间和精力编写与之对应的接口文档，从而导致工作效率低下，开发成本较高。

发明内容

有鉴于此，本发明实施例提供了一种接口文档生成方法及终端设备，以解决因需要开发人员花费大量的时间和精力编写接口文档而导致工作效率低下，开发成本较高的问题。

本发明实施例的第一方面提供了一种接口文档生成方法，可以包括：

在接收到开发人员下发的生成目标代码的接口文档的指令后，生成与所述目标代码对应的接口文档；

获取所述目标代码的代码注解，所述代码注解是由所述开发人员在所述目标代码的编写过程中同步添加至对应的代码段上的；

从所述代码注解中提取预设的第一标识符标识的注解信息，根据所述第一标识符标识的注解信息生成所述目标代码的概要信息，并将所述概要信息添加入所述接口文档中；

从所述代码注解中提取预设的第二标识符标识的注解信息，根据所述第二标识符标识的注解信息生成所述目标代码的参数信息，并将所述参数信息添加入所述接口文档中；

从所述代码注解中提取预设的第三标识符标识的注解信息，根据所述第三标识符标识的注解信息确定所述目标代码的业务类别；

将所述接口文档存储入与所述目标代码的业务类别对应的预先创建的文档库中。

本发明实施例的第二方面提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，所述计算机程序被处理器执行时实现如下步骤：

在接收到开发人员下发的生成目标代码的接口文档的指令后，生成与所述目标代码对应的接口文档；

获取所述目标代码的代码注解，所述代码注解是由所述开发人员在所述目标代码的编写过程中同步添加至对应的代码段上的；

从所述代码注解中提取预设的第一标识符标识的注解信息，根据所述第一标识符标识的注解信息生成所述目标代码的概要信息，并将所述概要信息添加入所述接口文档中；

从所述代码注解中提取预设的第二标识符标识的注解信息，根据所述第二标识符标识的注解信息生成所述目标代码的参数信息，并将所述参数信息添加入所述接口文档中；

从所述代码注解中提取预设的第三标识符标识的注解信息，根据所述第三标识符标识的注解信息确定所述目标代码的业务类别；

将所述接口文档存储入与所述目标代码的业务类别对应的预先创建的文档库中。

本发明实施例的第三方面提供了一种接口文档生成终端设备，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现如下步骤：

在接收到开发人员下发的生成目标代码的接口文档的指令后，生成与所述目标代码对应的接口文档；

获取所述目标代码的代码注解，所述代码注解是由所述开发人员在所述目标代码的编写过程中同步添加至对应的代码段上的；

从所述代码注解中提取预设的第一标识符标识的注解信息，根据所述第一标识符标识的注解信息生成所述目标代码的概要信息，并将所述概要信息添加入所述接口文档中；

从所述代码注解中提取预设的第二标识符标识的注解信息，根据所述第二标识符标识的注解信息生成所述目标代码的参数信息，并将所述参数信息添加入所述接口文档中；

从所述代码注解中提取预设的第三标识符标识的注解信息，根据所述第三标识符标识的注解信息确定所述目标代码的业务类别；

将所述接口文档存储入与所述目标代码的业务类别对应的预先创建的文档库中。