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

权利要求书

1.一种注释说明的生成方法，其特征在于，包括：

读取源代码文件；

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

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

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

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

2.根据权利要求1所述的方法，其特征在于，所述将所述接口注释信息及所述接口调用信息分别存储在对应的变量中包括：

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

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

3.根据权利要求2所述的方法，其特征在于，所述将所述接口调用信息中不同类型的接口调用类型信息、以及不同名称的接口调用参数信息分别存储在对应的变量中之后，所述方法还包括；

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

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

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

4.根据权利要求3所述的方法，其特征在于，所述根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件包括：

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

5.根据权利要求1所述的方法，其特征在于，在得到所述源代码文件对应的注释说明文件之前，所述方法还包括：

判断所述源代码文件是否读取完毕；

若所述源代码文件没有读取完毕，则继续读取所述源代码文件；

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

6.一种注释说明的生成装置，其特征在于，包括：

第一读取单元，用于读取源代码文件；

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

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

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

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

7.根据权利要求6所述的装置，其特征在于，所述第一存储单元包括：

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

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

8.根据权利要求7所述的装置，其特征在于，所述装置还包括：

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

第二生成单元，用于根据所述接口调用返回类型信息生成数据返回格式信息；

第二存储单元，用于将所述数据返回格式信息存储在对应的变量中。