CN108241503A - 注释说明的生成方法及装置 - Google Patents

Abstract

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

Description

注释说明的生成方法及装置

技术领域

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

背景技术

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

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

发明内容

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

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

读取源代码文件；

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

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

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

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

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

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

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

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

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

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

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

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

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

可选的，在得到所述源代码文件对应的注释说明文件之前，所述方法还包括：

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

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

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

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

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

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

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

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

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

可选的，所述第一存储单元包括：

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

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

可选的，所述装置还包括：

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

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

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

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

可选的，所述装置还包括：

判断单元，用于在得到所述源代码文件对应的注释说明文件之前，判断所述源代码文件是否读取完毕；

第二读取单元，用于若所述源代码文件没有读取完毕，则继续读取所述源代码文件；

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

借由上述技术方案，本发明实施例提供的技术方案至少具有下列优点：

本发明实施例提供的一种注释说明的生成方法及装置，首先读取源代码文件，然后从所述源代码文件中获取接口注释信息及接口调用信息，所述接口注释信息包括接口功能注释信息及接口参数注释信息，所述接口调用信息包括接口调用参数信息及接口调用类型信息；定义多个用于存储信息的变量；将所述接口注释信息及所述接口调用信息分别存储在对应的变量中；根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件。与现有的源代码文件中注释更改后需要人为手动修改相比，本发明通过读取代码文件中的接口注释信息及接口调用信息，将接口注释信息及接口调用信息分别存储在定义的变量中，最后根据存储在变量中的接口注释信息、接口调用信息，以及预置注释转换规则自动生成源代码文件对应的注释说明文件，减少人为操作，实现代码中接口注释的自动生成，提高生成注释说明的效率。

上述说明仅是本发明技术方案的概述，为了能够更清楚了解本发明的技术手段，而可依照说明书的内容予以实施，并且为了让本发明的上述和其它目的、特征和优点能够更明显易懂，以下特举本发明的具体实施方式。

附图说明

通过阅读下文优选实施方式的详细描述，各种其他的优点和益处对于本领域普通技术人员将变得清楚明了。附图仅用于示出优选实施方式的目的，而并不认为是对本发明的限制。而且在整个附图中，用相同的参考符号表示相同的部件。在附图中：

图1示出了发明实施例提供的一种注释说明的生成方法的流程图；

图2示出了发明实施例提供的另一种注释说明的生成方法的流程图；

图3示出了发明实施例提供的一种注释说明的生成装置的方框图；

图4示出了发明实施例提供的另一种注释说明的生成装置的方框图。

具体实施方式

下面将参照附图更详细地描述本公开的示例性实施例。虽然附图中显示了本公开的示例性实施例，然而应当理解，可以以各种形式实现本公开而不应被这里阐述的实施例所限制。相反，提供这些实施例是为了能够更透彻地理解本公开，并且能够将本公开的范围完整的传达给本领域的技术人员。

本发明实施例提供一种注释说明的生成方法，如图1所示，所述方法包括：

101、读取源代码文件。

其中，所述读取的步骤可以为按照代源码执行的每一行进行获取源代码内容，当当前行全部读完之后，再进行下一行的读取。通过读取源代码文件，实现获取源代码中所有的标识符，避免具有意义的标识符的丢失。

102、从所述源代码文件中获取接口注释信息及接口调用信息。

其中，所述接口注释信息包括接口功能注释信息及接口参数注释信息，所述接口调用信息包括接口调用参数信息及接口调用类型信息，所述接口功能注释信息为介绍接口功能的信息，可以包括接口的作用等，所述接口参数注释信息为介绍接口参数的信息，可以为s、f等，所述接口调用参数信息可以为get、post等，所述接口调用类型信息为接口具体调用的类型，本发明实施例不做具体限定。

需要说明的是，从源代码文件中获取接口注释信息及接口调用信息可以通过检测标识信息进行获取，标识信息可以为代码文件中的符号组成，例如，{}、[]、//、<>、[}等，还可以为不同符号之间的组合，例如[}，本发明实施例不做具体限定。标识信息可以包括接口功能注释标识信息、接口参数注释标识信息、接口调用参数标识信息及接口调用类型标识信息，从代码文件中进行获取，获取的方法为查找代码中的标识信息具体对应符号可以根据现有代码注释中的符合规则设置，例如，[和}可以为接口功能注释标识信息，[和}之间的内容作为接口功能注释内容，包括接口的作用和对接口中各个参数的解释，本发明实施例不做具体限定。

103、定义多个用于存储信息的变量。

其中，所述定义的变量用于存储获取的信息，可以为向量、常量等形式，本发明实施例不做具体限定。

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

其中，所述接口注释信息中的接口功能注释信息及接口参数注释信息也分别存储在对应的变量中，所述接口调用信息中的接口调用参数信息及接口调用类型信息也分别存储在对应的变量中。

例如，可以根据[}和//确定接口注释信息，[}对应中间部分为注释内容，//对应后面的内容为接口参数注释信息，//与：中间对应接口参数信息，接口参数信息可以存储在变量key中，接口参数注释信息可以存储在变量value中。

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

其中，所述预置注释转换规则为可以将代码中的注释内容转化为文档形式的规则，例如apidoc规则，本发明实施例不做具体限定。

需要说明的是，生成的注释说明文件中的注释说明顺序与读取的源代码文件中的源代码的顺序相同，即注释说明文件的内容可以按照源代码执行的顺序将注释向用户进行展现。

本发明实施例提供的一种注释说明的生成方法，与现有的源代码文件中注释更改后需要人为手动修改相比，本发明通过读取代码文件中的接口注释信息及接口调用信息，将接口注释信息及接口调用信息分别存储在定义的变量中，最后根据存储在变量中的接口注释信息、接口调用信息，以及预置注释转换规则自动生成源代码文件对应的注释说明文件，减少人为操作，实现代码中接口注释的自动生成，提高生成注释说明的效率。

本发明实施例提供另一种注释说明的生成方法，如图2所示，所述方法包括：

201、读取源代码文件。

本步骤与图1所述步骤101所述的方法相同，这里不在赘述。

另外，读取源代码文件可以通过读取到标识信息获取到对应的注释信息，例如，{}、[]、//、<>、[}等，还可以为不同符号之间的组合，例如[}，本发明实施例不做具体限定。

需要说明的是，标识信息可以从源代码文件中进行获取，标识信息的具体对应符号可以根据现有代码注释中的符合规则设置，例如，[和}可以为接口标识信息，[和}之间的内容作为接口的注释，包括接口的作用和对接口中各个参数的解释，本发明实施例不做具体限定。

202、从所述源代码文件中获取接口注释信息及接口调用信息。

本步骤与图1所述步骤102所述的方法相同，这里不在赘述。

203、定义多个用于存储信息的变量。

本步骤与图1所述步骤103所述的方法相同，这里不在赘述。

另外，定义的多个变量存储信息的大小，可以根据技术人员预先进行设定，或者按照预设时间间隔进行清空设置，还可以为在生成一次注释说明文件之后自动进行删除变量中的内容，本发明实施例不做具体限定。

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

本步骤与图1所述步骤104所述的方法相同，这里不在赘述。

对于本发明实施例，步骤204具体可以为：将所述接口注释信息中不同功能的接口功能注释信息、以及不同名称的接口参数注释信息分别存储在不同的变量中；将所述接口调用信息中不同类型的接口调用类型信息、以及不同名称的接口调用参数信息分别存储在不同的变量中。

其中，所述变量的个数可以根据在定义存储信息的变量时，对接口注释信息及接口调用信息中的具体个数进行设定，以便生成足够存储信息的变量个数。存储在变量中的内容可以与变量之间的内容进行相关联。

例如，功能为a的接口功能注释信息存储在变量1中，功能b的接口功能注释信息存储在变量2中，以此类推，类型为get的接口调用类型信息存储在变量3中，类型为post的接口调用类型信息存储在变量4中。

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

其中，所述接口调用返回类型信息为通过调用的接口返回的不同类型的信息，例如，可以为DateTime,String,Int等，本发明实施例不做具体限定。

需要说明的是，所述接口调用返回类型信息可以通过标识信息进行接收到，标识信息可以根据技术人员进行预先设定，本发明实施例不做具体限定。

例如，根据[]可以确定接口调用类型信息，public空格...空格标识为接口调用返回类型信息，或者，查找到以List开头的代码时，后面的<>标识也为接口调用返回类型信息。

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

例如，[]标识为接口路由标识信息，中间部分为对应的接口路由get或者post等。当读取到以List开头的代码时，后面的<>标识中间部分为返回数据格式DateTime、String、Int，若为DateTime，则返回数据格式为2016-07-29，在变量中的存储以[2016-07-29]形式存在，当<>之间的类型不是DateTime、String、Int中的类型，则按照读取到的内容在项目所在目录中找到同名的文件。找到该文件中第二个{的下一行作为返回数据格式信息。

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

通过将数据返回格式信息存储在对应的变量中，以便在生成注释说明文件时直接从变量中提取对应的信息。

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

其中，所述预置注释转换规则为可以将源代码中的注释内容转化为文档形式的规则，例如apidoc规则，本发明实施例不做具体限定。所述生成的注释说明文件的格式可以为.js，还可以为其他格式类型，本发明实施例不做具体。

例如，生成的注释说明文件中，@api{}中间的内容为接口路由信息，@apidescription后面的内容为接口功能注释信息，@api param{}中间的内容为参数类型、参数名称、参数注释，@api Response后面为接口返回数据格式，@api SampleRequest后面的内容为api的端口号。

对于本发明实施例，步骤208之前还包括：判断所述源代码文件是否读取完毕；若所述源代码文件没有读取完毕，则继续读取所述源代码文件；若所述代码文件读取完毕，则根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件。

其中，所述代码文件读取完毕为代码文件中的所有代码均读取完毕。通过判断所述代码文件是否读取完毕，避免代码中的注释信息被漏掉。

对于本发明实施例，具体的应用场景可以如下所示，但不限于此，包括：读取API项目的control文件夹的cs文件，读取到源代码中public空格...空格标识，空格之间的内容作为参数类型，读取第二个空格后面的内容，如果读取到{标识，则读取到的内容作为参数名称；如果没有读取到{，则一直读到；前面。如果该行参数的类型非自定义类型，则按照该类型生成对应的类型；否则重复上述步骤，对于该文件中的其余行做同样的处理，直到读到}。另外，读取到(标识，读取(和后面的第一个空格之间的内容，作为第一个参数的类型，读取空格和第一个，之间的内容作为参数名称，直到查找到)，读取到接口调用类型信息为post，其他读取的信息不再赘述，则将读取到的参数名称、参数类型、接口调用类型信息等分别存储在对应的变量中，根据apidoc规则及存储在变量中的信息生成注释说明文件，其中，参数类型与参数名称之间可以用：相连。

本发明实施例提供的另一种注释说明的生成方法，本发明通过将读取源代码文件中的不同功能的接口功能注释信息、不同名称的接口参数注释信息及接口调用信息、不同类型的接口调用类型信息、不同名称的接口调用参数信息及根据不同类型的接口调用类型信息对应的接口调用返回类型信息生成的数据返回格式信息存储在变量中，将存储在定义的变量中的所有的信息，以及预置注释转换规则自动生成源代码文件对应的注释说明文件，实现代码中接口注释的自动生成，避免技术人员重复编写代码，提高生成注释说明的效率。

进一步地，作为图1所示方法的具体实现，本发明实施例提供一种注释说明的生成装置，如图3所示，所述装置可以包括：第一读取单元31、获取单元32、定义单元33、第一存储单元34、第一生成单元35。

第一读取单元31，用于读取源代码文件；第一读取单元31为一种注释说明的生成装置执行读取源代码文件的功能模块。

获取单元32，用于从所述源代码文件中获取接口注释信息及接口调用信息，所述接口注释信息包括接口功能注释信息及接口参数注释信息，所述接口调用信息包括接口调用参数信息及接口调用类型信息；获取单元32为一种注释说明的生成装置执行从所述源代码文件中获取接口注释信息及接口调用信的功能模块。

定义单元33，用于定义多个用于存储信息的变量；定义单元33为一种注释说明的生成装置执行定义多个用于存储信息的变量的功能模块。

第一存储单元34，用于将所述接口注释信息及所述接口调用信息分别存储在对应的变量中；第一存储单元34为一种注释说明的生成装置执行将所述接口注释信息及所述接口调用信息分别存储在对应的变量中的功能模块。

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

本发明实施例提供的一种注释说明的生成装置，与现有的源代码文件中注释更改后需要人为手动修改相比，本发明通过读取代码文件中的接口注释信息及接口调用信息，将接口注释信息及接口调用信息分别存储在定义的变量中，最后根据存储在变量中的接口注释信息、接口调用信息，以及预置注释转换规则自动生成源代码文件对应的注释说明文件，减少人为操作，实现代码中接口注释的自动生成，提高生成注释说明的效率。

该装置实施例与前述方法实施例对应，为便于阅读，本装置实施例不再对前述方法实施例中的细节内容进行逐一赘述，但应当明确，本实施例中的装置能够对应实现前述方法实施例中的全部内容。

进一步地，作为图2所示方法的具体实现，本发明实施例提供另一种注释说明的生成装置，如图4所示，所述装置可以包括：第一读取单元41、获取单元42、定义单元43、第一存储单元44、第一生成单元45、接收单元46、第二生成单元47、第二存储单元48、判断单元49、第二读取单元410。

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

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

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

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

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

进一步地，所述第一存储单元44包括：

第一存储模块4401，用于将所述接口注释信息中不同功能的接口功能注释信息、以及不同名称的接口参数注释信息分别存储在不同的变量中；第一存储模块4401为另一种注释说明的生成装置执行将所述接口注释信息中不同功能的接口功能注释信息、以及不同名称的接口参数注释信息分别存储在不同的变量中的功能模块。

第二存储模块4402，具体还用于将所述接口调用信息中不同类型的接口调用类型信息、以及不同名称的接口调用参数信息分别存储在不同的变量中。第二存储模块4402为另一种注释说明的生成装置执行将所述接口调用信息中不同类型的接口调用类型信息、以及不同名称的接口调用参数信息分别存储在不同的变量中的功能模块。

进一步地，所述装置还包括：

接收单元46，用于接收不同类型的接口调用类型信息对应的接口调用返回类型信息；接收单元46为另一种注释说明的生成装置执行接收不同类型的接口调用类型信息对应的接口调用返回类型信息的功能模块。

第二生成单元47，还用于根据所述接口调用返回类型信息生成数据返回格式信息；第二生成单元47为另一种注释说明的生成装置执行根据所述接口调用返回类型信息生成数据返回格式信息的功能模块。

第二存储单元48，还用于将所述数据返回格式信息存储在对应的变量中。第二存储单元48为另一种注释说明的生成装置执行将所述数据返回格式信息存储在对应的变量中的功能模块。

所述第一生成单元45，具体用于将存储在对应变量中的所述接口参数注释信息、所述接口调用参数信息、所述接口功能注释信息、所述接口调用参数信息以及所述数据返回格式，按照注释转换规则进行拼接，并配置在所述预置注释转换规则对应的参数中，得到所述源代码文件对应的注释说明文件。第一生成单元45为另一种注释说明的生成装置执行将存储在对应变量中的所述接口参数注释信息、所述接口调用参数信息、所述接口功能注释信息、所述接口调用参数信息以及所述数据返回格式，按照注释转换规则进行拼接，并配置在所述预置注释转换规则对应的参数中，得到所述源代码文件对应的注释说明文件的功能模块。

进一步地，所述装置还包括：判断单元49，第二读取单元410，

所述判断单元49，用于判断所述源代码文件是否读取完毕；判断单元49为另一种注释说明的生成装置执行判断所述源代码文件是否读取完毕的功能模块。

所述第二读取单元410，还用于若所述源代码文件没有读取完毕，则继续读取所述源代码文件；第二读取单元410为另一种注释说明的生成装置执行若所述源代码文件没有读取完毕，则继续读取所述源代码文件的功能模块。

所述第一生成单元45，还用于若所述代码文件读取完毕，则根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件。第一生成单元45为另一种注释说明的生成装置执行若所述代码文件读取完毕，则根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件的功能模块。

本发明实施例提供的另一种注释说明的生成装置，本发明通过将读取源代码文件中的不同功能的接口功能注释信息、不同名称的接口参数注释信息及接口调用信息、不同类型的接口调用类型信息、不同名称的接口调用参数信息及根据不同类型的接口调用类型信息对应的接口调用返回类型信息生成的数据返回格式信息存储在变量中，将存储在定义的变量中的所有的信息，以及预置注释转换规则自动生成源代码文件对应的注释说明文件，实现代码中接口注释的自动生成，避免技术人员重复编写代码，提高生成注释说明的效率。

该装置实施例与前述方法实施例对应，为便于阅读，本装置实施例不再对前述方法实施例中的细节内容进行逐一赘述，但应当明确，本实施例中的装置能够对应实现前述方法实施例中的全部内容。

所述注释说明的生成装置包括处理器和存储器，上述第一读取单元、获取单元、定义单元、第一存储单元和第一生成单元等均作为程序单元存储在存储器中，由处理器执行存储在存储器中的上述程序单元来实现相应的功能。

处理器中包含内核，由内核去存储器中调取相应的程序单元。内核可以设置一个或以上，通过调整内核参数来解决代码文件中的注释更改后，需要人为修改注释文件的问题。

存储器可能包括计算机可读介质中的非永久性存储器，随机存取存储器(RAM)和/或非易失性内存等形式，如只读存储器(ROM)或闪存(flash RAM)，存储器包括至少一个存储芯片。

本申请还提供了一种计算机程序产品，当在数据处理设备上执行时，适于执行初始化有如下方法步骤的程序代码：读取源代码文件；从所述源代码文件中获取接口注释信息及接口调用信息，所述接口注释信息包括接口功能注释信息及接口参数注释信息，所述接口调用信息包括接口调用参数信息及接口调用类型信息；定义多个用于存储信息的变量；将所述接口注释信息及所述接口调用信息分别存储在对应的变量中；根据存储在变量中的接口注释信息及接口调用信息，以及预置注释转换规则生成所述源代码文件对应的注释说明文件。

本领域内的技术人员应明白，本申请的实施例可提供为方法、系统、或计算机程序产品。因此，本申请可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本申请可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器、CD-ROM、光学存储器等)上实施的计算机程序产品的形式。

本申请是参照根据本申请实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

在一个典型的配置中，计算设备包括一个或多个处理器(CPU)、输入/输出接口、网络接口和内存。

存储器可能包括计算机可读介质中的非永久性存储器，随机存取存储器(RAM)和/或非易失性内存等形式，如只读存储器(ROM)或闪存(flash RAM)。存储器是计算机可读介质的示例。

计算机可读介质包括永久性和非永久性、可移动和非可移动媒体可以由任何方法或技术来实现信息存储。信息可以是计算机可读指令、数据结构、程序的模块或其他数据。计算机的存储介质的例子包括，但不限于相变内存(PRAM)、静态随机存取存储器(SRAM)、动态随机存取存储器(DRAM)、其他类型的随机存取存储器(RAM)、只读存储器(ROM)、电可擦除可编程只读存储器(EEPROM)、快闪记忆体或其他内存技术、只读光盘只读存储器(CD-ROM)、数字多功能光盘(DVD)或其他光学存储、磁盒式磁带，磁带磁磁盘存储或其他磁性存储设备或任何其他非传输介质，可用于存储可以被计算设备访问的信息。按照本文中的界定，计算机可读介质不包括暂存电脑可读媒体(transitory media)，如调制的数据信号和载波。

以上仅为本申请的实施例而已，并不用于限制本申请。对于本领域技术人员来说，本申请可以有各种更改和变化。凡在本申请的精神和原理之内所作的任何修改、等同替换、改进等，均应包含在本申请的权利要求范围之内。

Claims (10)

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

读取源代码文件；

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

9.根据权利要求8所述的装置，其特征在于，

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

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

判断单元，用于在得到所述源代码文件对应的注释说明文件之前，判断所述源代码文件是否读取完毕；

第二读取单元，用于若所述源代码文件没有读取完毕，则继续读取所述源代码文件；

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