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

摘要

本发明属于计算机技术领域，尤其涉及一种接口文档生成方法及终端设备。开发人员在代码的编写过程中在代码段上同步添加对应的代码注解，在这些代码注解中使用预设的标识符分别标识概要信息、参数信息以及业务类别等内容，当开发人员完成代码编写并下发生成接口文档的指令后，本发明实施例的方法可以分别提取这些标识符标识的注解信息，将其添加到生成的接口文档中，从而自动地完成了接口文档的编写，并可自动地将生成的接口文档存储入对应的文档库中，大大减少了需要开发人员参与的时间，可以有效地提高工作效率并降低开发成本。

主权项

一种接口文档生成方法，其特征在于，包括：在接收到开发人员下发的生成目标代码的接口文档的指令后，生成与所述目标代码对应的接口文档；获取所述目标代码的代码注解，所述代码注解是由所述开发人员在所述目标代码的编写过程中同步添加至对应的代码段上的；从所述代码注解中提取预设的第一标识符标识的注解信息，根据所述第一标识符标识的注解信息生成所述目标代码的概要信息，并将所述概要信息添加入所述接口文档中；从所述代码注解中提取预设的第二标识符标识的注解信息，根据所述第二标识符标识的注解信息生成所述目标代码的参数信息，并将所述参数信息添加入所述接口文档中；从所述代码注解中提取预设的第三标识符标识的注解信息，根据所述第三标识符标识的注解信息确定所述目标代码的业务类别；将所述接口文档存储入与所述目标代码的业务类别对应的预先创建的文档库中。