CN110502275B - 项目开发文档的维护方法、装置、计算机设备和存储介质 - Google Patents

Abstract

本申请涉及研发管理领域，本申请公开了一种项目开发文档的维护方法、装置、计算机设备和存储介质，所述方法包括：获取项目开发代码文件，获得分别与控制层与业务层对应的代码信息，并与项目开发文档中的代码信息进行比较，获得比较结果。本申请通过在项目开发代码文件中查询调用方法、参数及返回值，生成项目开发维护文档并与项目开发文档进行比较，获得匹配结果，可快速了解一个项目版本的功能，提高开发文档的维护效率。

Description

项目开发文档的维护方法、装置、计算机设备和存储介质

技术领域

本申请涉及研发管理领域，特别涉及一种项目开发文档的维护方法、装置、计算机设备和存储介质。

背景技术

当前，在一个软件项目从开始到成熟的过程中，中间会产生很多的代码、文件以及技术迭代，最初始还有项目的相关人员进行维护，但是越往后由于人员的流动，代码接口文档可能会无法实时更新，后期由于需求以及场景的变更，代码及相应的文档会发生变动，因此项目开发文档也会相应更新，这就需要开发人员去手动维护，导致效率降低。

发明内容

本申请的目的在于针对现有技术的不足，提供一种项目开发文档的维护方法、装置、计算机设备和存储介质，通过在项目开发代码文件中查询调用方法、参数及返回值，生成项目开发维护文档并与项目开发文档进行比较，获得匹配结果，可快速了解一个项目版本的功能，提高开发文档的维护效率。

为达到上述目的，本申请的技术方案提供一种项目开发文档的维护方法、装置、计算机设备和存储介质。

本申请公开了一种项目开发文档的维护方法，包括以下步骤：

获取项目开发代码文件，在与控制层对应的所述项目开发代码文件中进行遍历查询，获得与控制层对应的每个项目开发代码文件中的所有调用方法，将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中；

在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中；

根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档；

获取项目开发文档，根据在所述项目开发代码文件中获得的调用方法在所述项目开发文档及项目开发维护文档中进行查询，分别获得与所述调用方法对应的代码信息，将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，根据所述比较结果输出代码匹配结果信息。

较佳地，所述将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中之前，包括：

预设注释关键字及查询行数；

当获取到所述调用方法后，根据所述预设的注释关键字及查询行数在所述项目开发代码文件中进行查询，获得与每个调用方法对应的注释，将所述注释与所述调用方法进行对应后存储在临时缓存中。

较佳地，所述在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，包括：

预设参数类型；

根据所述预设的参数类型在所述获取的调用方法中进行遍历查询，获得与所述预设的参数类型对应的所有参数。

较佳地，所述在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中之后，包括：

在与控制层对应的项目开发代码文件中根据所述获得的调用方法进行查询，获得与所述调用方法对应的返回值；

将所述返回值与所述调用方法进行对应后存储在临时缓存中。

较佳地，所述在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中之后，包括：

在与业务层对应的项目开发代码文件中根据所述每个调用方法中的参数进行查询，获得所述参数中每个参数的返回值；

将所述每个参数的返回值与所述参数进行对应后存储在临时缓存中。

较佳地，所述根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档，包括：

在所述临时缓存中进行查询，获得调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系；

根据所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系生成项目开发维护文档；

当所述项目开发维护文档生成后，将所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系从所述临时缓存中删除。

较佳地，所述将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，包括：

将所述项目开发文档中的参数、参数返回值及调用方法返回值与所述项目开发维护文档中的参数、参数返回值及调用方法返回值进行比较；

当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的参数不匹配时，发送参数不匹配信息；当所述项目开发文档与所述项目开发维护文档中所属相同的参数的参数返回值不匹配时，发送参数返回值不匹配信息；当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的调用方法返回值不匹配时，发送调用方法返回值不匹配信息。

本申请还公开了一种项目开发文档的维护装置，所述装置包括：

第一查询模块：设置为获取项目开发代码文件，在与控制层对应的所述项目开发代码文件中进行遍历查询，获得与控制层对应的每个项目开发代码文件中的所有调用方法，将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中；

第二查询模块：设置为在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中；

文档生成模块：设置为根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档；

信息比较模块：设置为获取项目开发文档，根据在所述项目开发代码文件中获得的调用方法在所述项目开发文档及项目开发维护文档中进行查询，分别获得与所述调用方法对应的代码信息，将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，根据所述比较结果输出代码匹配结果信息。

本申请还公开了一种计算机设备，所述计算机设备包括存储器和处理器，所述存储器中存储有计算机可读指令，所述计算机可读指令被一个或多个所述处理器执行时，使得一个或多个所述处理器执行上述所述维护方法的步骤。

本申请还公开了一种计算机存储介质，所述计算机存储介质存储有计算机指令，所述计算机可读指令被一个或多个处理器执行时，使得一个或多个处理器执行上述所述维护方法的步骤。

本申请的有益效果是：本申请通过在项目开发代码文件中查询调用方法、参数及返回值，生成项目开发维护文档并与项目开发文档进行比较，获得匹配结果，可快速了解一个项目版本的功能，提高开发文档的维护效率。

附图说明

图1为本申请第一个实施例的一种项目开发文档的维护方法的流程示意图；

图2为本申请第二个实施例的一种项目开发文档的维护方法的流程示意图；

图3为本申请第三个实施例的一种项目开发文档的维护方法的流程示意图；

图4为本申请第四个实施例的一种项目开发文档的维护方法的流程示意图；

图5为本申请第五个实施例的一种项目开发文档的维护方法的流程示意图；

图6为本申请第六个实施例的一种项目开发文档的维护方法的流程示意图；

图7为本申请第七个实施例的一种项目开发文档的维护方法的流程示意图；

图8为本申请实施例的一种项目开发文档的维护装置结构示意图。

具体实施方式

为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本申请进行进一步详细说明。应当理解，此处所描述的具体实施例仅仅用以解释本申请，并不用于限定本申请。

本技术领域技术人员可以理解，除非特意声明，这里使用的单数形式“一”、“一个”、“所述”和“该”也可包括复数形式。应该进一步理解的是，本申请的说明书中使用的措辞“包括”是指存在所述特征、整数、步骤、操作、元件和/或组件，但是并不排除存在或添加一个或多个其他特征、整数、步骤、操作、元件、组件和/或它们的组。

本申请第一个实施例的一种项目开发文档的维护方法流程如图1所示，本实施例包括以下步骤：

步骤s101，获取项目开发代码文件，在与控制层对应的所述项目开发代码文件中进行遍历查询，获得与控制层对应的每个项目开发代码文件中的所有调用方法，将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中；

具体的，在一个软件开发项目中，通常会包含多个项目开发代码文件，所述项目开发代码文件由于各自实现的功能不同，会存储在不同的层中，例如：控制层、业务层；其中每个层会包含多个文件夹，每个文件夹中包含多个文件，而每个文件中会包含具体实现的代码，即所述代码会包含不同的调用方法、参数以及返回值等。

具体的，首先可获取项目开发代码文件，并在与控制层对应的所述项目开发代码文件中进行遍历查询，所述遍历查询指的是对控制层中每个文件夹中的每个文件中的代码进行遍历查询，获得与控制层对应的每个项目开发代码文件中的所有调用方法；当对与控制层对应的每个项目开发代码文件中的代码进行查询时，所述查询可通过JAVA的反射机制进行，通过所述JAVA的反射机制获得调用方法后，可将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中，由于在一个项目开发代码文件中，可能会存在多个调用方法，因此所述的对应关系为一对多，即一个项目开发代码文件对应一个或多个调用方法，然后将所述调用方法、项目开发代码文件以及调用方法与项目开发代码文件之间的对应关系存储在临时缓存中，所述项目开发代码文件与调用方法之间的对应关系包括将所述项目开发代码文件名与每个调用方法名进行绑定，如果是一个项目开发代码文件与一个调用方法进行对应，则将所述项目开发代码文件名与所述调用方法名进行绑定，例如：项目开发代码文件A与调用方法a进行绑定；如果是一个项目开发代码文件与多个调用方法进行对应，则将所述项目开发代码文件名与所述多个调用方法名进行绑定，例如：项目开发代码文件A与调用方法a、调用方法b及调用方法c进行绑定。

步骤s102，在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中；

具体的，当获得调用方法后，可在所述获得的调用方法中进行遍历查询，所述遍历查询指的是在每个调用方法的代码中进行遍历查询，获得每个调用方法中的所有参数，所述参数是在控制层中的调用方法中获得，然后可根据所述在控制层获得的参数在与业务层对应的项目开发代码文件中进行查询，获得在所述业务层中与所述参数对应的数值；当对所述所有在控制层中获得的参数查询完之后，获得所有与所述参数对应的参数数值，然后将所述参数数值与所述参数进行一一对应，即一个参数对应一个参数数值，而参数是由调用方法获得的，因此可将所述调用方法与所述参数进行对应，由于一个调用方法中可能包含多个参数，因此所述参数与所述调用方法是多对一的对应关系；当获得所有的参数、参数数值、参数与参数数值之间的对应关系以及参数与调用方法之间的对应关系后，可将所述参数、参数数值、参数与参数数值之间的对应关系以及参数与调用方法之间的对应关系存储在临时缓存中。

步骤s103，根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档；

具体的，当在控制层中成功获得调用方法、项目开发代码文件以及调用方法与项目开发代码文件之间的对应关系，并在业务层中成功获得参数、参数数值、参数与参数数值之间的对应关系以及参数与调用方法之间的对应关系之后，可根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档。所述项目开发维护文档包括项目开发代码文件名、调用方法名、参数名、调用方法返回值、参数返回值及注释等字段，其中，一个项目开发代码文件名可与多个调用方法名对应，一个调用方法名可与多个参数对应，一个调用方法名仅与一个调用方法返回值对应，一个调用方法可与多个注释对应，一个参数仅与一个参数返回值对应，如表1所示：

表1

步骤s104，获取项目开发文档，根据在所述项目开发代码文件中获得的调用方法在所述项目开发文档及项目开发维护文档中进行查询，分别获得与所述调用方法对应的代码信息，将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，根据所述比较结果输出代码匹配结果信息。

具体的，当获得项目开发维护文档后，为了与所述项目开发维护文档中的信息进行比对，还需获取项目开发文档，当获取到项目开发文档后，可根据在所述项目开发代码文件中获得的调用方法在所述项目开发文档中进行查询，获得与所述调用方法对应的代码信息，所述代码信息包括与所述调用方法对应的参数及参数数值信息，然后将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果。

具体的，所述比较包括将所述项目开发维护文档中的字段信息与项目开发文档中的与所述字段信息对应的信息进行比较，例如，可将项目开发文档中的所有项目开发代码文件名获取，然后根据所述项目开发代码文件名获取所述项目开发文档中的调用方法、参数、调用方法返回值、参数返回值及注释等信息；并根据每个调用方法名在项目开发维护文档中进行查询，获得与所述调用方法名对应的调用方法返回值、参数、参数返回值及注释；最后将分别属于项目开发文档和项目开发维护文档的同属一个调用方法的参数进行比较，将分别属于项目开发文档和项目开发维护文档的同属一个调用方法的调用方法返回值进行比较，将分别属于项目开发文档和项目开发维护文档的同属一个参数的参数返回值进行比较；所述比较结果包括匹配或者不匹配，例如，当分别属于项目开发文档和项目开发维护文档的同属一个调用方法的参数进行比较后，如果匹配，则输出参数匹配信息，否则输出参数不匹配信息，所述参数不匹配信息包括不匹配参数的参数名及与所述不匹配参数名对应的调用方法及项目开发代码文件，当分别属于项目开发文档和项目开发维护文档的同属一个调用方法的调用方法返回值进行比较后，如果匹配，则输出调用方法返回值匹配信息，如果不匹配，则输出调用方法返回值不匹配信息，所述调用方法返回值不匹配信息包括调用方法返回值及与所述调用方法返回值对应的调用方法名及项目开发代码文件名，当分别属于项目开发文档和项目开发维护文档的同属一个参数的参数返回值进行比较后，如果匹配，则输出参数返回值匹配信息，否则输出参数返回值不匹配信息，所述参数返回值不匹配信息包括参数返回值及与所述参数返回值对应的参数名、调用方法名及项目开发代码文件名。

本实施例中，通过在项目开发代码文件中查询调用方法、参数及返回值，生成项目开发维护文档并与项目开发文档进行比较，获得匹配结果，可快速了解一个项目版本的功能，提高开发文档的维护效率。

图2为本申请第二个实施例的一种项目开发文档的维护方法流程示意图，如图所示，所述步骤s101，将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中之前，包括：

步骤s201，预设注释关键字及查询行数；

具体的，还在预先在系统中预设注释关键字及查询行数，用于查询代码中的注释，所述注释关键字可以是“/*”及“*/”符号，所述的查询行数指的是查询的总行数，例如，查询的是调用方法之前的10行。

步骤s202，当获取到所述调用方法后，根据所述预设的注释关键字及查询行数在所述项目开发代码文件中进行查询，获得与每个调用方法对应的注释，将所述注释与所述调用方法进行对应后存储在临时缓存中。

具体的，当获取到所述调用方法后，可根据预设的注释关键字及查询行数在所述项目开发代码文件中进行查询，获得与每个调用方法对应的注释，并将所述注释与所述调用方法进行对应后存储在临时缓存中，所述的对应关系是一一对应，即一个调用方法对应一个注释。

本实施例中，通过获取每个调用方法的注释，可在对项目代码进行维护时获取详细的代码信息，提高代码维护效率。

图3为本申请第三个实施例的一种项目开发文档的维护方法流程示意图，如图所示，所述步骤s102，在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，包括：

步骤s301，预设参数类型；

具体的，可在系统中预设参数的类型，用于对调用方法中的所有参数进行查询，所述参数的类型可包含：整型、字符、接口等等。

步骤s302，根据所述预设的参数类型在所述获取的调用方法中进行遍历查询，获得与所述预设的参数类型对应的所有参数。

具体的，当获取到所述调用方法后，可根据所述预设的参数类型在所述获取的调用方法中进行遍历查询，获得与所述预设的参数类型对应的所有参数。

本实施例中，通过预设参数类型，可有效获得调用方法中的所有参数。

图4为本申请第四个实施例的一种项目开发文档的维护方法流程示意图，如图所示，所述步骤s102，在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中之后，包括：

步骤s401，在与控制层对应的项目开发代码文件中根据所述获得的调用方法进行查询，获得与所述调用方法对应的返回值；

具体的，当获取到所述调用方法后，可在与控制层对应的项目开发代码文件中根据所述获得的调用方法进行查询，获得与所述调用方法对应的返回值；所述返回值一般都是跟在“return”后面，因此可在调用方法中通过查询“return”关键词获取返回值。

步骤s402，将所述返回值与所述调用方法进行对应后存储在临时缓存中。

具体的，当获取到所述调用方法的返回值后，可将所述调用方法的返回值与所述调用方法进行对应，所述调用方法的返回值与所述调用方法的对应关系是一对一，即一个调用方法对应一个调用方法返回值，并将所述调用方法的返回值及与所述调用方法的对应关系存储在临时缓存中。

本实施例中，通过对调用方法中返回值的获取，可在对代码进行维护时提供详细的代码信息，提高代码维护效率。

图5为本申请第五个实施例的一种项目开发文档的维护方法流程示意图，如图所示，所述步骤s102，在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中之后，包括：

步骤s501，在与业务层对应的项目开发代码文件中根据所述每个调用方法中的参数进行查询，获得所述参数中每个参数的返回值；

具体的，当获取到控制层中的参数之后，可在与业务层对应的项目开发代码文件中根据所述每个调用方法中的参数进行查询，获得所述参数中每个参数的返回值；所述返回值一般都是跟在“return”后面，因此可在参数后通过查询“return”关键词获取返回值。

步骤s502，将所述每个参数的返回值与所述参数进行对应后存储在临时缓存中。

具体的，当获取到所述参数的返回值后，可将所述参数的返回值与所述参数进行对应，所述参数的返回值与所述参数的对应关系是一对一，即一个参数应一个参数返回值，并将所述参数的返回值及与所述参数的对应关系存储在临时缓存中。

本实施例中，通过对参数返回值的获取，可在对代码进行维护时提供详细的代码信息，提高代码维护效率。

图6为本申请第六个实施例的一种项目开发文档的维护方法流程示意图，如图所示，所述步骤s103，根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档，包括：

步骤s601，在所述临时缓存中进行查询，获得调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系；

具体的，所述临时缓存中存储的是项目开发代码文件、调用方法、参数、参数数值、参数返回值、调用方法返回值以及所述项目开发代码文件与所述调用方法之间的对应关系、所述调用方法与所述参数之间的对应关系、所述参数与所述参数数值之间的对应关系、所述参数与所述参数返回值之间的对应关系、所述调用方法与所述调用方法返回值之间的对应关系，因此通过临时缓存的查询，可获得项目开发代码文件、调用方法、参数、参数数值、参数返回值、调用方法返回值以及所述项目开发代码文件与所述调用方法之间的对应关系、所述调用方法与所述参数之间的对应关系、所述参数与所述参数数值之间的对应关系、所述参数与所述参数返回值之间的对应关系、所述调用方法与所述调用方法返回值之间的对应关系。

步骤s602，根据所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系生成项目开发维护文档；

具体的，可根据所述项目开发代码文件、调用方法、参数、参数数值、参数返回值、调用方法返回值以及所述项目开发代码文件与所述调用方法之间的对应关系、所述调用方法与所述参数之间的对应关系、所述参数与所述参数数值之间的对应关系、所述参数与所述参数返回值之间的对应关系、所述调用方法与所述调用方法返回值之间的对应关系生成项目开发维护文档，所述项目开发维护文档包含项目开发代码文件，其中，每个项目开发代码文件对应多个调用方法，每个调用方法对应多个参数，每个调用方法对应一个调用方法返回值，每个参数对应一个参数数值，每个参数对应一个参数返回值。

步骤s603，当所述项目开发维护文档生成后，将所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系从所述临时缓存中删除。

具体的，当所述项目开发维护文档生成后，可将所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系从所述临时缓存中删除。

本实施例中，通过在所述项目开发维护文档生成后对所述临时缓存进行清空，可以提高内存利用效率。

图7为本申请第七个实施例的一种项目开发文档的维护方法流程示意图，如图所示，所述步骤s104，将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，包括：

步骤s701，将所述项目开发文档中的参数、参数返回值及调用方法返回值与所述项目开发维护文档中的参数、参数返回值及调用方法返回值进行比较；

具体的，当获得所述项目开发文档中的参数、参数返回值、调用方法返回值及所述项目开发维护文档中的参数、参数返回值、调用方法返回值后，可将所述项目开发文档中的参数与所述项目开发维护文档中的参数、所述项目开发文档中的参数返回值与所述项目开发维护文档中的参数返回值、所述项目开发文档中的调用方法返回值与所述项目开发维护文档中的调用方法返回值分别进行比较，所述的比较必须是同属性的比较，例如，同属同一个参数的两个参数数值进行比较，或者同属同一个调用方法的两个参数进行比较。

步骤s702，当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的参数不匹配时，发送参数不匹配信息；当所述项目开发文档与所述项目开发维护文档中所属相同的参数的参数返回值不匹配时，发送参数返回值不匹配信息；当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的调用方法返回值不匹配时，发送调用方法返回值不匹配信息。

具体的，通过比较之后，可获得相应的比较结果，所述比较结果包括：所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的参数不匹配，当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的参数不匹配时，这时可发送参数不匹配信息；所述项目开发文档与所述项目开发维护文档中所属相同的参数的参数返回值不匹配，当所述项目开发文档与所述项目开发维护文档中所属相同的参数的参数返回值不匹配时，这时可发送参数返回值不匹配信息；所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的调用方法返回值不匹配，当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的调用方法返回值不匹配时，这时可发送调用方法返回值不匹配信息。

本实施例中，通过对项目开发代码文件中的信息的比较，获得比较结果，并可根据比较结果对代码进行维护，可提高代码维护效率。

本申请实施例的一种项目开发文档的维护装置结构如图8所示，包括：

第一查询模块801、第二查询模块802、文档生成模块803及信息比较模块804；其中，第一查询模块801与第二查询模块802相连，第二查询模块802与文档生成模块803相连，文档生成模块803与信息比较模块804相连；第一查询模块801设置为获取项目开发代码文件，在与控制层对应的所述项目开发代码文件中进行遍历查询，获得与控制层对应的每个项目开发代码文件中的所有调用方法，将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中；第二查询模块802设置为在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中；文档生成模块803设置为根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档；信息比较模块804设置为获取项目开发文档，根据在所述项目开发代码文件中获得的调用方法在所述项目开发文档及项目开发维护文档中进行查询，分别获得与所述调用方法对应的代码信息，将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，根据所述比较结果输出代码匹配结果信息。

本申请实施例还公开了一种计算机设备，所述计算机设备包括存储器和处理器，所述存储器中存储有计算机可读指令，所述计算机可读指令被一个或多个所述处理器执行时，使得一个或多个所述处理器执行上述各实施例中所述维护方法中的步骤。

本申请实施例还公开了一种计算机存储介质，所述计算机存储介质存储有计算机可读指令，所述计算机可读指令被一个或多个处理器执行时，使得一个或多个处理器执行上述各实施例中所述维护方法中的步骤。

本领域普通技术人员可以理解实现上述实施例方法中的全部或部分流程，是可以通过计算机程序来指令相关的硬件来完成，该计算机程序可存储于一计算机可读取存储介质中，该程序在执行时，可包括如上述各方法的实施例的流程。其中，前述的存储介质可为磁碟、光盘、只读存储记忆体(Read-Only Memory，ROM)等非易失性存储介质，或随机存储记忆体(Random Access Memory，RAM)等。

以上所述实施例的各技术特征可以进行任意的组合，为使描述简洁，未对上述实施例中的各个技术特征所有可能的组合都进行描述，然而，只要这些技术特征的组合不存在矛盾，都应当认为是本说明书记载的范围。

以上所述实施例仅表达了本申请的几种实施方式，其描述较为具体和详细，但并不能因此而理解为对本申请专利范围的限制。应当指出的是，对于本领域的普通技术人员来说，在不脱离本申请构思的前提下，还可以做出若干变形和改进，这些都属于本申请的保护范围。因此，本申请专利的保护范围应以所附权利要求为准。

Claims (9)

1.一种项目开发文档的维护方法，其特征在于，包括以下步骤：

获取项目开发代码文件，在与控制层对应的所述项目开发代码文件中进行遍历查询，获得与控制层对应的每个项目开发代码文件中的所有调用方法，将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中；

在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中；

根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档；

获取项目开发文档，根据在所述项目开发代码文件中获得的调用方法在所述项目开发文档及项目开发维护文档中进行查询，分别获得与所述调用方法对应的代码信息，将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，根据所述比较结果输出代码匹配结果信息；

所述根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档，包括：

在所述临时缓存中进行查询，获得调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系；

根据所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系生成项目开发维护文档；

当所述项目开发维护文档生成后，将所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系从所述临时缓存中删除。

2.如权利要求1所述的项目开发文档的维护方法，其特征在于，所述将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中之前，包括：

预设注释关键字及查询行数；

当获取到所述调用方法后，根据所述预设的注释关键字及查询行数在所述项目开发代码文件中进行查询，获得与每个调用方法对应的注释，将所述注释与所述调用方法进行对应后存储在临时缓存中。

3.如权利要求1所述的项目开发文档的维护方法，其特征在于，所述在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，包括：

预设参数类型；

根据所述预设的参数类型在所述获取的调用方法中进行遍历查询，获得与所述预设的参数类型对应的所有参数。

4.如权利要求1所述的项目开发文档的维护方法，其特征在于，所述在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中之后，包括：

在与控制层对应的项目开发代码文件中根据所述获得的调用方法进行查询，获得与所述调用方法对应的返回值；

将所述返回值与所述调用方法进行对应后存储在临时缓存中。

5.如权利要求4所述的项目开发文档的维护方法，其特征在于，所述在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中之后，包括：

在与业务层对应的项目开发代码文件中根据所述每个调用方法中的参数进行查询，获得所述参数中每个参数的返回值；

将所述每个参数的返回值与所述参数进行对应后存储在临时缓存中。

6.如权利要求1所述的项目开发文档的维护方法，其特征在于，所述将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，包括：

将所述项目开发文档中的参数、参数返回值及调用方法返回值与所述项目开发维护文档中的参数、参数返回值及调用方法返回值进行比较；

当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的参数不匹配时，发送参数不匹配信息；当所述项目开发文档与所述项目开发维护文档中所属相同的参数的参数返回值不匹配时，发送参数返回值不匹配信息；当所述项目开发文档与所述项目开发维护文档中所属相同的调用方法的调用方法返回值不匹配时，发送调用方法返回值不匹配信息。

7.一种项目开发文档的维护装置，其特征在于，所述装置包括：

第一查询模块：设置为获取项目开发代码文件，在与控制层对应的所述项目开发代码文件中进行遍历查询，获得与控制层对应的每个项目开发代码文件中的所有调用方法，将所述调用方法与所述项目开发代码文件进行对应后存储在临时缓存中；

第二查询模块：设置为在所述获得的调用方法中进行遍历查询，获得每个调用方法中的所有参数，根据所述获得的参数在与业务层对应的项目开发代码文件中进行查询，获得所述参数对应的数值，将所述参数及参数数值与所述调用方法进行对应后存储在临时缓存中；

文档生成模块：设置为根据所述临时缓存中的所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系，生成项目开发维护文档；

信息比较模块：设置为获取项目开发文档，根据在所述项目开发代码文件中获得的调用方法在所述项目开发文档及项目开发维护文档中进行查询，分别获得与所述调用方法对应的代码信息，将所述项目开发文档中与所述调用方法对应的代码信息与所述项目开发维护文档中的代码信息进行比较，获得比较结果，根据所述比较结果输出代码匹配结果信息；

所述文档生成模块，具体设置为：在所述临时缓存中进行查询，获得调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系；

根据所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系生成项目开发维护文档；

当所述项目开发维护文档生成后，将所述调用方法、调用方法返回值、参数、参数数值、参数返回值及所述调用方法返回值与所述调用方法之间的对应关系、所述参数返回值与所述参数之间的对应关系、所述调用方法与所述项目开发代码文件之间的对应关系、所述参数及参数数值与所述调用方法之间的对应关系从所述临时缓存中删除。

8.一种计算机设备，其特征在于，所述计算机设备包括存储器和处理器，所述存储器中存储有计算机可读指令，所述计算机可读指令被一个或多个所述处理器执行时，使得一个或多个所述处理器执行如权利要求1至6中任一项所述维护方法的步骤。

9.一种计算机存储介质，其特征在于，所述计算机存储介质存储有计算机可读指令，所述计算机可读指令被一个或多个处理器执行时，使得一个或多个处理器执行如权利要求1至6中任一项所述维护方法的步骤。