[发明专利]注释说明的生成方法及装置

说明书

本发明公开了一种注释说明的生成方法及装置，涉及计算机技术领域，主要目的在于解决代码文件中的注释更改后，需要人为修改注释文件的问题。本发明的主要技术方案为：读取源代码文件；从所述源代码文件中获取接口注释信息及接口调用信息，所述接口注释信息包括接口功能注释信息及接口参数注释信息，所述接口调用信息包括接口调用参数信息及接口调用类型信息；定义多个用于存储信息的变量；将所述接口注释信息及所述接口调用信息分别存储在对应的变量中；根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件。主要用于注释说明的生成。

技术领域

本发明涉及计算机技术领域，尤其涉及一种注释说明的生成方法及装置。

背景技术

应用程序编程接口(Application Programming Interface,API)在提供调用接口的同时，会给调用接口方也提供一个说明文档，使得调用接口方通过说明文档了解调用接口的功能、接口返回的数据格式、调用接口参数等。

目前，可以通过在系统控制器中的源文件里添加注释，然后按照apidoc规则生成html格式的文档，或者安装一个helppage安装包，将源文件里的注释添加在.cs格式的文件中，还可以将API的注释直接编写在.js格式的文件里，得到说明文档。但是，helppage安装包生成.cs格式的说明文档无法实现调用接口，另外，当需要更改注释或添加注释时，需要手动修改源文件中的注释，重新按照apidoc规则生成html格式的文档，或者直接重新手动编写.js格式的文件，耗时长，增大开发人员的工作量，降低API注释的效率。

发明内容

鉴于上述问题，提出了本发明以便提供一种注释说明的生成方法及装置，主要目的是解决代码文件中的注释更改后，需要人为修改注释文件的问题。

借由上述技术方案，本发明提供的一种注释说明的生成方法，包括：

读取源代码文件；

从所述源代码文件中获取接口注释信息及接口调用信息，所述接口注释信息包括接口功能注释信息及接口参数注释信息，所述接口调用信息包括接口调用参数信息及接口调用类型信息；

定义多个用于存储信息的变量；

将所述接口注释信息及所述接口调用信息分别存储在对应的变量中；

根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件。

可选的，所述将所述接口注释信息及所述接口调用信息分别存储在对应的变量中包括：

将所述接口注释信息中不同功能的接口功能注释信息、以及不同名称的接口参数注释信息分别存储在不同的变量中；

将所述接口调用信息中不同类型的接口调用类型信息、以及不同名称的接口调用参数信息分别存储在不同的变量中。

可选的，所述将所述接口调用信息中不同类型的接口调用类型信息、以及不同名称的接口调用参数信息分别存储在对应的变量中之后，所述方法还包括；

接收不同类型的接口调用类型信息对应的接口调用返回类型信息；

根据所述接口调用返回类型信息生成数据返回格式信息；

将所述数据返回格式信息存储在对应的变量中。

可选的，所述根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件包括：

将存储在对应变量中的所述接口参数注释信息、所述接口调用参数信息、所述接口功能注释信息、所述接口调用参数信息以及所述数据返回格式，按照注释转换规则进行拼接，并配置在所述预置注释转换规则对应的参数中，得到所述源代码文件对应的注释说明文件。