CN105512034A - 一种评审方法和评审系统 - Google Patents

Abstract

本发明实施例提供一种评审方法和评审系统，通过获取待评审文件以及根据待评审文件的文件类型获取评审规则，根据待评审文件和评审规则生成选择页面，由评审人员选择评审规则以及对待评审文件执行评审，并将评审结果和评审意见提交到数据库。在评审过程中为评审人员提供评审规则，使评审人员能够更加规范地对待评审文件进行评审，避免完全依赖评审经验，提高评审质量和效率。

Description

一种评审方法和评审系统

技术领域

本发明涉及计算机技术领域，具体地，涉及一种代码评审系统和代码评审方法。

背景技术

为了控制软件质量，开发团队有必要对重要和关键代码及文档作评审活动。评审人员通过对文件的审查来发现一些问题，从而来预防缺陷。为了支持这一活动，业界产生了很多工具类软件，这类软件通过和版本管理工具结合，获取变更的代码文件并通知评审人员，评审人员收到通知以后，对变更文件进行评审，之后把评审意见记录在系统中。

现有评审系统，没有对评审规则进行汇总，在评审阶段也没有对评审人员提供规则支持，导致评审人员往往只根据已往经验作评审，这样可能会因为评审者本身的技术水平所限造成评审不全面等，影响评审效率。

另外，现有系统对评审结果的记录，只是评审人员输入的一段文字形式，或系统之外的文本记录，没有对评审意见作分类汇总，不能按照评审意见检索和统计。

发明内容

有鉴于此，本发明提供评审系统和评审方法，对评审人员在评审阶段提供支持，以利于提升评审质量和评审效率。

根据本发明的第一方面，提供一种评审方法，包括：获取待评审文件；根据文件类型获取多个第一规则，所述第一规则为预定义的规则组；根据所述待评审文件和所述第一规则生成选择页面；从所述选择页面上选择一个或多个所述第一规则；根据选择的所述第一规则进行评审，并输入评审意见；以及将评审结果和所述评审意见存储到数据库。

优选地，所述获取多个第一规则包括：如果所述文件类型为java文件，获取java评审规则；如果所述文件类型为jsp文件，获取jsp评审规则；如果所述文件类型为其他类型，获取其他类型文件评审规则。

优选地，所述选择页面显示待评审文件的变更内容，以及根据所述第一规则生成的多选框或多选按钮。

优选地，还包括：根据所述评审结果进行统计。

优选地，还包括：定时器定时获取所述待评审文件的更新记录，根据所述更新记录通知评审人。

根据本发明的第二方面，提供一种评审系统，包括：文件获取模块，用于获取待评审文件；规则获取模块，用于根据文件类型获取多个第一规则，所述第一规则为预定义的规则组；评审规则维护模块，用于管理第一规则；评审处理模块，用于选择一个或多个所述第一规则，根据选择的所述第一规则进行评审，并输入评审意见；页面生成模块，用于根据所述待评审文件和所述第一规则生成选择页面；数据库模块，用于将评审结果和所述评审意见存储到数据库。

优选地，规则获取模块包括：如果所述文件类型为java文件，获取java评审规则；如果所述文件类型为jsp文件，获取jsp评审规则；如果所述文件类型为其他类型，获取其他类型文件评审规则。

优选地，所述评审规则维护模块包括：

增加所述第一规则、删除所述第一规则和修改所述第一规则。

优选地，还包括：统计模块，用于根据所述评审结果进行统计。

优选地，页面生成模块生成包括待评审文件的变更内容以及所述第一规则的多选框或多选按钮的选择页面。

优选地，还包括：定时器模块，用于定时获取所述待评审文件的更新记录，根据所述更新记录通知评审人。

本发明实施例提供一种评审方法和评审系统，通过获取待评审文件以及根据待评审文件的文件类型获取评审规则，根据待评审文件和评审规则生成选择页面，由评审人员选择评审规则以及对待评审文件执行评审，并将评审结果和评审意见提交到数据库。在评审过程中为评审人员提供评审规则，使评审人员能够更加规范地对待评审文件进行评审，避免完全依赖评审经验，提高评审质量和效率。

附图说明

通过参照以下附图对本发明实施例的描述，本发明的上述以及其它目的、特征和优点将更为清楚，在附图中：

图1是根据本发明实施例的评审方法的流程图；

图2是根据本发明另一实施例的评审方法的流程图；

图3是根据本发明实施例的评审系统的结构图。

具体实施方式

以下基于实施例对本发明进行描述，但是本发明并不仅仅限于这些实施例。在下文对本发明的细节描述中，详尽描述了一些特定的细节部分。对本领域技术人员来说没有这些细节部分的描述也可以完全理解本发明。为了避免混淆本发明的实质，公知的方法、过程、流程没有详细叙述。另外附图不一定是按比例绘制的。

附图中的流程图、框图图示了本发明实施例的系统、方法、装置的可能的体系框架、功能和操作，流程图和框图上的方框可以代表一个模块、程序段或仅仅是一段代码，所述模块、程序段和代码都是用来实现规定逻辑功能的可执行指令。也应当注意，所述实现规定逻辑功能的可执行指令可以重新组合，从而生成新的模块和程序段。因此附图的方框以及方框顺序只是用来更好的图示实施例的过程和步骤，而不应以此作为对发明本身的限制。

图1是根据本发明实施例的评审方法的流程图。所述评审方法包括步骤101-步骤106。

在步骤101中，获取待评审文件。待评审文件包括各类代码文件以及文本文件。代码文件的类型包括C/C++/C#/JAVA/JSP/PHP等不同编码类型的编码文件。文本文件为在软件周期的不同阶段产生的各类电子文档，可能是word文件或pdf文件或文本格式，从用途区分可分为规范文档、设计文档、测试文档、运营文档等。上述文档一般通过版本管理软件进行管理，目前市场上提供成熟的版本管理软件，如cvs,Clearcase等。本步骤中，从版本管理软件或其他存储位置获取待评审文件。

在步骤102中，根据文件类型获取多个第一规则。如前所述，待评审文件包括多种类型的代码文件和文本文档。基于研发过程中的实践活动，根据不同的文件类型定义评审规则。一个或多个评审规则构成第一规则。

在步骤103中，根据待评审文件和第一规则生成选择页面。待评审文件和第一规则统一显示在一个页面中。在一个优选的实施中，只显示已变更的待评审文件或只显示待评审文件的已变更部分，将检索到多个第一规则按照多选框或者多选按钮的形式显示，以方便评审人员选择。

在步骤104中，选择一个或多个所述第一规则。在本步骤中，从选择页面中选择第一规则，用于之后的评审活动。

在步骤105中，根据选择的所述第一规则进行评审，并输入评审意见。即，判断待评审文件的内容是否满足评审规则。如果是代码文件，可以逐句地判断评审规则是否通过，在必要的时候，输入评审意见。例如，对程序员的编码错误进行指正，对一贯良好的编码风格给予表扬，对重大的逻辑错误给出具体的改正方法。

在步骤106中，将评审结果和所述评审意见存储到数据库。评审结果包括规则选择，代码以及文本内容是否通过规则等。将评审结果和评审意见保存到数据库中，方便检索和统计。在一个优选的实施中，根据评审结果进行统计，例如可以统计通过某条规则的代码数量，代码百分比，或文件数量等。

图2是根据本发明另一个实施例的评审方法的流程图。所述评审方法包括步骤200-步骤210。

在步骤200中，获取待评审文件。待评审文档一般通过版本管理软件进行管理，目前市场上提供成熟的版本管理软件，如cvs,Clearcase等。本步骤中，从版本管理软件或其他存储方式获取待评审文件。在一个优选的实施例中，定时启动一个定时器获取待评审文件的更新记录，并将更新记录通知给评审人员，评审人员据此安排评审。在另一个优选实施例，每次获取自上一次评审后又发生变更的待评审文件。

在步骤201中，文件类型为java。文件类型为java,执行步骤202，否则执行步骤203。

在步骤202中，查询java评审规则。

在步骤203中，文件类型为jsp。文件类型为jsp，执行步骤204，否则执行步骤205。

在步骤204中，查询jsp评审规则。

在步骤205中，文件为其他类型。文件类型为其他类型，执行步骤206。

在步骤206中，查询其他类型评审规则。

在步骤201-步骤206中，对待评审文件类型进行判断，java类型的文件检索java评审规则，jsp类型文件检索jsp评审规则，其他类型评审文件检索其他类型的评审规则，以获取匹配的评审规则。

在步骤207中，生成选择页面。根据上述步骤中检索的评审规则和待评审文件，生成选择页面，选择页面上显示待评审文件内容和评审规则。在一个优选的实施例，评审规则被显示为多选框或多选按钮。在另一个优选实施例，在选择页面上显示待评审文件，焦点位于待评审文件的已变更内容。

在步骤208中，选择待评审文件符合的规则项。从选择页面中选择一个或几个规则。

在步骤209中，执行评审，输入评审意见。即，判断待评审文件的内容是否满足评审规则。如果是代码文件，可以逐句地判断评审规则是否通过，在必要的时候，输入评审意见。例如，对程序员的编码错误进行指正，对一贯良好的编码风格给予表扬，对重大的逻辑错误给出具体的改正方法。

在步骤210中，保存评审结果和评审意见。评审结果包括规则选择，代码以及文本内容是否通过规则等。将评审结果和评审意见保存到数据库中，方便检索和统计。

根据上述评审方法，本发明实施例提供一种评审系统，如图3所示，包括文件获取模块301，规则获取模块302，页面生成模块303，评审处理模块304，评审规则维护模块305和数据库模块306。

文件获取模块301从版本管理系统或其他位置获取待评审文件。

规则获取模块302根据文件获取模块301获取的文件类型获取多个规则。例如，java类型的文件获取java评审规则，jsp类型文件获取jsp评审规则，其他类型评审文件获取其他类型的评审规则

页面生成模块303根据模块301和模块302中获取的待评审文件和规则生成选择页面。选择页面上显示待评审文件内容和评审规则。在一个优选的实施例，评审规则被显示为多选框或多选按钮，待评审内容只显示已变更内容。

评审处理模块304从选择页面上选择一个或多个评审规则，根据选择的评审规则进行评审，并输入评审意见。

数据库模块306将评审结果和评审意见存储到数据库。

上述评审系统还包括评审规则维护模块305用于管理员维护规则，对规则进行增删改。所述评审规则通过数据库模块306保存到数据库。

在一个实施例中，规则获取模块302被配置为：如果所述文件类型为java文件，获取java评审规则；如果所述文件类型为jsp文件，获取jsp评审规则；如果所述文件类型为其他类型，获取其他类型文件评审规则。

在另一个实施例中，上述评审系统还包括统计模块，根据评审结果进行统计。在一个优选的实施中，根据评审结果进行统计，例如可以统计通过某条规则的代码数量，代码百分比，或文件数量等。

在另一个实施例中，上述评审系统还包括定时器模块，用于定时获取所述待评审文件的更新记录，根据所述更新记录通知评审人员。可以通过邮件或短信方式通知评审人员。同时在页面生成模块中根据更新记录决定是否显示那些评审文件，例如只显示更新后的待评审文件或者只显示待评审文件的变更内容。

本发明实施例提供一种评审方法和评审系统，通过获取待评审文件以及根据待评审文件的文件类型获取评审规则，根据待评审文件和评审规则生成选择页面，由评审人员选择评审规则以及对待评审文件执行评审，并将评审结果和评审意见提交到数据库。在评审过程中为评审人员提供评审规则，使评审人员能够更加规范地对待评审文件进行评审，避免完全依赖评审经验，加强评审活动的规范化和智能化。

本领域技术人员可以理解，根据本发明的数据处理系统的各个模块或单元可以通过硬件、固件或软件实现。软件例如包括采用JAVA、C/C++/C#、SQL等各种编程语言形成的编码程序。虽然在方法以及方法图例中给出本发明实施例的步骤以及步骤的顺序，但是所述步骤实现规定的逻辑功能的可执行指令可以重新组合，从而生成新的步骤。所述步骤的顺序也不应该仅仅局限于所述方法以及方法图例中的步骤顺序，可以根据功能的需要随时进行调整。例如将其中的某些步骤并行或按照相反顺序执行。

根据本发明的数据处理系统和方法可以部署在单个或多个服务器上。例如，可以将不同的模块分别部署在不同的服务器上，形成专用服务器。或者，可以在多个服务器上分布式部署相同的功能单元、模块或系统，以减轻负载压力。所述服务器包括但不限于在同一个局域网以及通过Internet连接的多个PC机、PC服务器、刀片机、超级计算机等。

以上所述仅为本发明的优选实施例，并不用于限制本发明，对于本领域技术人员而言，本发明可以有各种改动和变化。凡在本发明的精神和原理之内所作的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims (11)

1.一种评审方法，包括：

获取待评审文件；

根据文件类型获取多个第一规则，所述第一规则为预定义的规则组；

根据所述待评审文件和所述第一规则生成选择页面；

从所述选择页面上选择一个或多个所述第一规则；

根据选择的所述第一规则进行评审，并输入评审意见；以及

将评审结果和所述评审意见存储到数据库。

2.根据权利要求1所述的评审方法，其中，所述获取多个第一规则包括：

如果所述文件类型为java文件，获取java评审规则；

如果所述文件类型为jsp文件，获取jsp评审规则；

如果所述文件类型为其他类型，获取其他类型文件评审规则。

3.根据权利要求1所述的评审方法，其中，所述选择页面显示待评审文件的变更内容，以及根据所述第一规则生成的多选框或多选按钮。

4.根据权利要求1所述的评审方法，还包括：根据所述评审结果进行统计。

5.根据权利要求1所述的评审办法，还包括：定时器定时获取所述待评审文件的更新记录，根据所述更新记录通知评审人。

6.一种评审系统，包括：

文件获取模块，用于获取待评审文件；

规则获取模块，用于根据文件类型获取多个第一规则，所述第一规则为预定义的规则组；

评审规则维护模块，用于管理所述第一规则；

评审处理模块，用于选择一个或多个所述第一规则，根据选择的所述第一规则进行评审，并输入评审意见；

页面生成模块，用于根据所述待评审文件和所述第一规则生成选择页面；

数据库模块，用于将评审结果和所述评审意见存储到数据库。

7.根据权利要求6所述的评审系统，其中，所述规则获取模块包括：

如果所述文件类型为java文件，获取java评审规则；

如果所述文件类型为jsp文件，获取jsp评审规则；

如果所述文件类型为其他类型，获取其他类型文件评审规则。

8.根据权利要求6所述的评审系统，所述评审规则维护模块包括：

增加所述第一规则、删除所述第一规则和修改所述第一规则。

9.根据权利要求6所述的评审系统，还包括：统计模块，用于根据所述评审结果进行统计。

10.根据权利要求6所述的评审方法，其中，页面生成模块生成包括待评审文件的变更内容以及所述第一规则的多选框或多选按钮的选择页面。

11.根据权利要求6所述的评审系统，还包括：定时器模块，用于定时获取所述待评审文件的更新记录，根据所述更新记录通知评审人。