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

权利要求书

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

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

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

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

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

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

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

2.根据权利要求1所述的接口文档生成方法，其特征在于，所述根据所述第一标识符标识的注解信息生成所述目标代码的概要信息包括：

获取与所述第一标识符标识的注解信息对应的代码段的首行代码中的关键字；

根据获取的所述关键字判断与所述第一标识符标识的注解信息对应的代码段是否为类代码；

若与所述第一标识符标识的注解信息对应的代码段为类代码，则根据所述第一标识符标识的注解信息生成所述目标代码的总体概要信息；

若与所述第一标识符标识的注解信息对应的代码段为函数代码或方法代码，则根据所述第一标识符标识的注解信息生成所述目标代码的章节概要信息。

3.根据权利要求1所述的接口文档生成方法，其特征在于，在将所述接口文档存储入与所述目标代码的业务类别对应的预先创建的文档库中之后，还包括：

当检测到所述目标代码被所述开发人员修改后，获取所述目标代码的修改后的代码注解；

将所述修改后的代码注解与预先保存的原始代码注解进行对比，得到所述修改后的代码注解与所述原始代码注解之间的差异，所述原始代码注解为修改前的所述目标代码的代码注解；

根据所述修改后的代码注解与所述原始代码注解之间的差异对所述接口文档进行修订。

4.根据权利要求3所述的接口文档生成方法，其特征在于，所述修改后的代码注解与所述原始代码注解之间的差异包括：

所述修改后的代码注解与所述原始代码注解相比所增加的代码注解、删除的代码注解和/或更改的代码注解；

所述根据所述修改后的代码注解与所述原始代码注解之间的差异对所述接口文档进行修订包括：

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

和/或

将所述删除的代码注解所对应的参数信息从所述接口文档中删除；

和/或

从所述更改的代码注解中提取所述第二标识符标识的注解信息，根据所述第二标识符标识的注解信息生成更改的参数信息，并使用所述更改的参数信息替换所述接口文档中对应的参数信息。

5.根据权利要求1至4中任一项所述的接口文档生成方法，其特征在于，在根据所述第二标识符标识的注解信息生成所述目标代码的参数信息，并将所述参数信息添加入所述接口文档中之后，还包括：

在所述接口文档中创建与所述参数信息对应的链接；

当检测到所述链接被点击时，调取并显示所述目标代码中与所述第二标识符标识的注解信息对应的代码段。

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