CN105589837B - 一种电子文档的自动查错方法 - Google Patents

Abstract

本发明公开了一种电子文档的自动查错方法，包括：依据被测文档要检查的内容定制检查项；将所述定制检查项生成VBA文件，再将所述VBA文件导入到Office的宏中；所述的VBA文件设置为检查内容定义区、检查项模块区以及执行区；在检查内容定义区是对所述检查项模块标记的变量名和对所述检查项模块的说明；所述检查项模块区用于实现将定制的检查项按照检查流程执行相应的检查逻辑；在所述的执行区中，调用定制好的检查项，并将出错的内容和出错的位置写入到所述检查报告中。与采用人工检查电子文档的方式相比，自动化程度高，且提高了处理效率和准确率。

Description

一种电子文档的自动查错方法

技术领域

本发明涉及一种电子文档领域，尤其是一种电子文档的自动查错方法。

背景技术

核电站仪控***是核电站的“神经中枢”，是确保核电厂安全、可靠运行的重要装备，而核电站仪控***在设计和使用中，会产生大量的电子文档，例如，在核电站仪控***中相关软件、硬件在各个测试阶段中所产生的测试文档。而在大批量电子文档编写和整理过程中，由于方方面面的原因可能出现各类错误，因此使得文档的查错过程必不可少，而以往采用人工方式，需要检查成百上千页的文档，往往耗费大量人力成本；在兼顾多个检查点时，往往容易造成遗漏，导致检查过的文档，依然可能存在不少错误；并且对文档检查过后需要手工对各个错误做记录，提交给文档编写者修改，整个过程速度慢、效率低。

发明内容

为解决现有技术中采用人工检查电子文档的方式效率低且准确度不高的问题，本发明采用基于VBA程序语言的技术，通过定制自动检查逻辑代码的方式实现软件自动检查，从而取代人工检查的方法，实现对文档中的多个检查项同时自动执行检查，提高处理效率和准确率。具体方案如下：一种电子文档的自动查错方法，包括以下步骤：

S1：依据文档中要检查的内容，定制检查项；

S2：将所述定制的检查项生成VBA文件，再将所述VBA文件导入到Office的宏中；

S3：在宏窗口选择运行命令对整个文档进行检查，所述检查是通过VBA文件编写的代码实现逻辑处理；

S4：弹出提示文档检查完成窗口，并输出存储所有错误内容的检查报告。

优选的，包括以下步骤：

1)在所述VBA文件中设置：检查内容定义区、检查项模块区以及执行区,其中，

所述的检查项模块区，包括检查标记变量和定制的检查项对应的检查代码；

所述的检查标记变量包括用于表示检查种类的变量名和变量值；

所述检查内容定义区，用于显示所有定制的检查项，及定制的检查项的说明；

所述执行区，包括调用需要执行定制的检查项和将错误数据生成报告；

2)将所述的检查项模块区中的定制的检查项在所述的检查内容定义区中进行说明，也就是在所述的检查内容定义区中显示所有定制的检查项以及每个定制的检查项对应的标记变量名；

3)在所述的检查项模块区中，将所述定制的检查项按照检查流程形成检查代码，生成每个定制的检查项对应的检查模块；

4)在所述的执行区中，通过调用所述的检查项模块区中的变量名，对所述定制的检查项执行检查，并将出错的内容和出错的位置写入到所述检查报告中。

优选的，所述的调用检查项为1个或多个。

优选的，所述的变量值的初始值为“正确”，如果在检查过程中发现该项检查内容存在错误，则将变量值赋值为“待修改”；在执行所述步骤4)时，将所有变量值为“待修改”所对应的内容写入所述检查报告。

优选的，所述定制的检查项包括：新定制检查项和固有检查项；将定制的检查项生成对应的检查模块的步骤为：

(4-1)：在已经存在的VBA文件中查找，待检查的检查项是否在检查项模块区已经被定义为检查模块，如果是则执行步骤(4-2)，否则执行步骤(4-3)；

(4-2)：将存在的检查项对应的模块复制到所述的固有检查项中；重复执行步骤(4-1)，直到所有待检查的检查项在VBA文件中都有对应的模块；

(4-3)：对于在已经存在的VBA文件中没有的检查项，则根据检查内容建立新的检查项模块，即形成所述的新定制检查项，重复执行步骤(4-1)，直到所有要检查的检查项在VBA文件中都有对应的模块。

优选的，所述的电子文档是核电站仪控***中相关软件和硬件在测试阶段涉及的文档，所述文档为excel文件。

优选的，定制检查项包括：页眉检查，所述的页眉检查定义为检查模块的步骤为：

(6-1)使用函数ActiveSheet.Name获取第一个工作表名称，作为当前工作表；

(6-2)使用函数GetHeadPageName获取所述当前工作表的页眉名称；

(6-3)使用函数StrComp对第一个工作表名称和当前工作表的页眉名称进行比较，如果名称一致，则检查下一个工作表，否则写入到检查报告中；

(6-4)如果当前工作表是最后一个工作表，则执行结束，否则取后一个工作表为当前工作表，获取工作表名称将执行步骤(6-2)。

优选的，定制检查项还包括单元格关联检查，所述的单元格关联检查定义为检查模块的步骤：

(7-1)设置关联列，所述关联列包括：第一关联列和第二关联列；

(7-2)设置关联规则为：(a)第一关联列的值为“通过”时对应第二关联列的内容为空，(b)第一关联列的值为“未通过”时对应第二关联列的内容为被测设备编号；

(7-3)使用函数ActiveWorkbook.Worksheets(i).Cells(j,k).Value获取当前工作表的第一关联列第一行的字段内容和第二关联列第一行的字段内容，作为当前工作表的当前行；其中，变量I表示第几张工作表，变量j表示工作表的第几行，变量k表示工作表的第几列。

(7-4)根据步骤(7-2)规定的规则，对步骤(7-3)获取的内容进行判断，如果符合关联规则(a)或(b)，则检查下一行数据，否则写入到检查报告中；

(7-5)如果当前行是最后一行，则执行结束，否则获取下一行为当前行对应的第一关联列的字段内容和第二关联列的字段内容，执行步骤(7-4)；

优选的，所述的关联列可为多列；

优选的，所述的关联规则是根据测试要求进行的定制。

优选的，在步骤S3中，所述的逻辑处理包括采用循环、遍历的逻辑处理方法。

优选的，在步骤S4中生成的所述检查报告存储为可在计算机上显示的文档，并将所述文档存储在计算机中。

优选的，所述的检查报告格式为word文档、txt文档。

本发明通过采用基于VBA程序语言的技术，通过定制自动检查逻辑代码的方式实现软件自动检查，从而取代人工检查的方法，通过使用一种自动化手段，实现快速、准确的检查出文件中包含的各类错误，如格式错误、内容错误以及逻辑错误等，并将检查出的错误生成检查报告，逐个罗列出来，清晰的标记出错误位置，便于文档编写者快速的定位错误并修改错误，帮助提高文档质量，节省在文档检查上的人力投入。

附图说明

下面结合附图对本发明的一种电子文档的自动查错方法进行具体说明。

图1是本发明电子文档的自动查错方法的流程图；

图2是本发明实现过程的总体流程图；

图3是图2在本发明实现过程的简化流程图；

图4是本发明形成检查项的过程框图；

图5是本发明页眉检查的流程图；

图6是本发明单元格关联检查的流程图；

图7是本发明编号规范性和连续性检查的流程图；

图8是本发明检查报告得到结果的部分显示界面截图。

具体实施方式

本发明通过使用VBA技术实现对文档的自动检查，并能将检查的错误内容生成检查报告，便于文档编写者快速定位错误位置并修改文档，提高对文档的处理效率。如图2所示，其中虚线部分为本发明在整个应用过程中要实现的具体内容，图3为图2在本发明实现部分的简化流程图，图3虚线圈定的部分是在第一次进行某类检查项的文档检查时设定的，再次检查同类型文档的检查项可忽略这两个步骤。如图1所示，本发明实现的检查过程包括定制检查项、导入检查项、执行检查、输出生成的报告。具体实现过程的内容包括：

(一)定制检查项

此步骤是将要检查的内容进行梳理，抽象成一条条检查项，并用VBA语言逐个描述这些检查项的逻辑，构成一个个检查模块。以核电站仪控***中通信板卡软件单元测试用例的文档(以下简称为测试用例的文档)为例，具体介绍检查项实现检查的方法。例如，在测试用例的文档所定制的检查项包括：文档的页眉检查、文档的单元格关联检查以及文档编号的规范性和连续性检查，具体描述如下：

1)对测试用例的文档的页眉检查为检查页眉名称是否与文档名称一致；

2)在测试用例的文档中对相关单元格内容的关联检查是检查文档中单元格与单元格之间是否根据所定制的对应关系一一对应，其测试用例的文档部分内容如下表所示：

测试数据号	测试结果	测试结论	缺陷编号
				D01	与预期结果一致	通过	/
D02	返回失败	未通过	CTEC_102256
				D03	与预期结果一致	通过	CTEC_134854
D04	返回失败	未通过	/

所述关联检查是检查字段为测试结论和字段为缺陷编号二者是否存在以下的对应关系：如果字段为测试结论的内容为“通过”，则字段为缺陷编号对应的内容为空；如果字段为测试结论的内容为“不通过”，则字段为缺陷编号对应一个编号。在上表中，测试数据号为D01、D02的测试结论与缺陷编号对应关系正确，测试数据号为D03、D04的测试结论与缺陷编号对应关系错误。

3)对测试用例的文档编号的规范性和连续性检查是判断字段的编号是否符合定制的编号格式和编号是否符合编号命名连续性的规定。

上述中的1)、2)、3)在本发明方法的定制检查项中可以选择三者之一或者三者之二或者也可以同时执行，也就是调用的检查项可以为1个或者多个，包括在下面的描述中涉及到的对定制检查项执行检查都可以如此进行。

(二)导入检查项

导入检查项就是将需要定制的检查项在VBA中实现，并通过Office提供的宏功能，将在VBA中实现的检查项导入到Office中，以执行相关定制的检查项的检查。其中，只需在首次执行检查前导入即可，以后再次执行检查时，就不需执行此操作。

1、定制的检查项在VBA中的实现方法为：

所有定制的检查项是通过VBA程序实现的，将VBA程序设置为几个区域，包括：检查内容定义区、检查项模块区、执行区；

检查内容定义区用于显示所有定制的检查项及检查项的说明，上述测试用例的文档定制的检查项在检查内容定义区显示的内容包括：

1)页眉检查，检查项的说明为：页眉名称是否与文档名称一致；

2)单元格关联检查，检查项的说明为：文档中单元格与单元格之间是否根据所定制的对应关系一一对应；

3)编号的规范性和连续性，检查项的说明为：判断字段的编号是否符合定制的编号格式和编号是否符合编号命名连续性的规定。

在检查项模块区中将测试用例的文档中定制的检查项：页眉检查、单元格关联检查以及编号的规范性和连续性检查，按照检查流程形成检查代码，生成每个定制的检查项对应的检查模块；

在VBA中定制检查项时，首先需要检查是否已经有被定义为VBA程序的检查项对应的检查模块，如果没有则需要新建检查项，而对于已经在VBA中定义好的检查项，只要将以前存在的检查项代码拷贝进来就可以，为了区别是新定制的检查项还是固有的检查项，通常将检查项模块区分为：新增检查项模块区和固有检查项模块区。

本发明提到的新增检查项模块是实现对指定类型文档的指定项检查，即根据检查内容建立新的检查项模块实现对新定制检查项的检查。在测试用例的文档所定制的检查项：文档的页眉检查、文档的单元格关联检查以及文档编号的规范性和连续性，如图4所示为新定制检查项从识别检查项到转化为代码的流程，包括：

第一步，明确检查项内容为页眉检查、单元格关联检查以及编号的规范性和连续性检查。

第二步，明确检查内容和逻辑可参照人工执行这项检查时的操作，包括：明确都需要做哪些工作，从哪里开始检查，检查的内容是什么，判定检查通过与否的标准是什么，何时认为检查可以结束；对第一步中所定制的检查项具体描述为：

1)页眉检查：从测试用例的文档中第一个工作表开始，判断是否为要检查的工作表，检查工作表的页眉名称是否和工作表的名称一致，接着检查下一个工作表的页眉名称，直到文档中最后一个工作表检查完成为止；

2)单元格关联检查：从测试用例的文档中第一个工作表开始，判断是否为要检查的工作表，按照要检查的关联列设置关联规则，对相应关联列的内容判断其对应关系是否符合关联规则，接着检查下一个工作表继续判断是否为要检查的工作表，直到文档中最后一个工作表检查完成为止；

3)编号的规范性和连续性检查：从测试用例的文档中第一个工作表开始，判断是否为要检查的工作表，检查字段的编号是否符合定制的编号格式和编号是否符合编号命名连续性的规定，接着检查下一个工作表继续判断是否为要检查的工作表，直到文档中最后一个工作表检查完成为止。

第三步，将第二步中涉及的流程和逻辑做整理和归纳，形成流程图结构；如图5所示为页眉检查的流程图；图6所示为单元格关联检查的流程图；图7所示为编号规范性和连续性检查的流程图。

第四步，使用VBA语言描述流程图中的各动作，包括循环、遍历等通用的逻辑处理方法。定制新的检查项，需新建一个标记变量，用来识别这类检查所产生的错误，再在新增检查项模块区中添加该模块的检查逻辑，最后在执行区调用该模块；以上述的页眉检查、单元格关联检查以及编号连续性和规范性检查来详细介绍检查项在VBA中的实现方法；

1)页眉检查

(1)使用函数ActiveSheet.Name获取第一个工作表名称，判断此页是否为测试用例工作表，如果不是跳到下一个工作表继续判断，否则执行步骤(2)；

(2)使用函数ActiveSheet.Name获取第一个工作表名称，作为当前工作表；

(3)使用函数GetHeadPageName获取所述当前工作表的页眉名称；

(4)使用函数StrComp对第一个工作表名称和当前工作表的页眉名称进行比较，如果名称一致，则检查下一个工作表，否则写入到检查报告中；

(5)如果当前工作表是最后一个工作表，则执行结束，否则取后一个工作表为当前工作表，获取工作表名称将执行步骤(3)。

2)单元格关联检查

(1)使用函数ActiveSheet.Name获取第一个工作表名称，判断此页是否为测试用例工作表，如果不是跳到下一个工作表继续判断，否则执行步骤(2)；

(2)设置关联列，所述关联列包括：第一关联列为测试结果和第二关联列为缺陷编号；

(3)设置关联规则为：(a)第一关联列的值为“通过”时对应第二关联列的内容为空，(b)第一关联列的值为“未通过”时对应第二关联列的内容为被测设备编号；

(4)使用函数ActiveWorkbook.Worksheets(i).Cells(j,k).Value获取当前工作表的关联列为测试结果和缺陷编号对应的字段内容；其中，变量I表示第几张工作表，变量j表示工作表的第几行，变量k表示工作表的第几列。

(5)根据步骤(3)规定的规则，对步骤(4)获取的内容进行判断，将发生错误的内容写入到检查报告中。

(6)如果当前行是最后一行，取后一个工作表名称判断此页是否为要检查的工作表，如果不是跳到下一个工作表继续判断，如果该工作表为要检查的工作表，则执行步骤(4)，否则获取下一行为当前行对应的测试结果和缺陷编号的字段内容，执行步骤(5)，如果当前工作表是最后一个工作表，则执行结束。

3)编号的规范性和连续性检查

(1)使用函数ActiveSheet.Name获取第一个工作表名称，判断此页是否为测试用例工作表，如果不是跳到下一个工作表继续判断，否则执行步骤(2)；

(2)使用函数ActiveWorkbook.Worksheets(i).Cells(j,k).Value获取当前工作表中字段为测试项编号，作为当前字段；

(3)使用函数StrComp判断是否符合规定的编号格式，如果检查时编号正确则执行步骤(4)，否则写入到报告中；

(4)对步骤(2)中获取的测试项编号进行判断是否符合编号命名连续性的规定，如果连续则检查下一个字段，执行步骤(2)，否则写入到报告中；

(5)如果当前字段为最后一个字段，则取后一个工作表名称判断此页是否为要检查的工作表，如果不是跳到下一个工作表继续判断，执行步骤(2)，如果当前工作表是最后一个工作表，则执行结束。

本发明提到的固有检查项模块区是存放固有检查项的模块，对于已经存在的检查项将其对应的检查模块复制到固有检查项模块区，需要哪些检查项直接将模块名称在执行区中调用即可实现检查功能。

本发明提到的执行区包括调用并执行在前面定义好的检查项对待检查文档进行检查以及在检查过程中将与检查项所定义的规则不相符的数据作为错误数据，并将错误的数据生成报告。

2、将定制的检查项在VBA中实现后，通过office提供的宏导入到要检查的文档中，即导入到上述的测试用例的文档中。

(三)执行检查

该步骤是在VBA代码成功导入到office电子文档后，打开待检查文档：测试用例的文档，点击该文档工具栏“视图”下的“宏”选项，选择“查看宏”，在宏窗口的列表下选择“文档自动检查”宏，点击执行按钮，便开始对文档进行检查。根据待检查文档大小的不同，检查过程可能需要几分钟时间，全部检查完毕后，会弹出对话框提示文档检查已完成。

(四)输出生成的报告

该功能是在VBA程序中的执行区进行处理的，也就是完成文档检查后，在存放待检查文档的路径下，会自动生成一个word文档的检查报告，报告中记录了文档的检查的错误内容和发生错误的详细位置，如图8所示为报告内容的一个截图。

报告可供文档编写人参考，可根据报告中提示的错误内容和位置修改文档，全部修改完成后，可再次打开待测试文档，按照步骤(三)执行检查，将检查的结果生成报告，直到所有错误全被修改完。这样，电子文档的查错过程就此执行结束。

上述实施例中的实施方案可以进一步组合或者替换，且实施例仅仅是对本发明的优选实施例进行描述，并非对本发明的构思和范围进行限定，在不脱离本发明设计思想的前提下，本领域中专业技术人员对本发明的技术方案作出的各种变化和改进，均属于本发明的保护范围。

Claims (9)

1.一种电子文档的自动查错方法，其特征在于，包括以下步骤：

S1：依据文档中要检查的内容，定制检查项，得到定制的检查项；

S2：将所述定制的检查项生成VBA文件，再将所述VBA文件导入到Office的宏中；

S3：在宏窗口选择运行命令对整个文档进行检查，所述检查是通过VBA文件编写的代码实现逻辑处理；

S4：弹出提示文档检查完成窗口，并输出存储所有错误内容的检查报告；

所述定制的检查项包括：新定制检查项和固有检查项；将定制的检查项生成对应的检查模块的步骤为：

(4-1)：在已经存在的VBA文件中查找，待检查的检查项是否在检查项模块区已经被定义为检查模块，如果是则执行步骤(4-2)，否则执行步骤(4-3)；

(4-2)：将存在的检查项对应的检查模块复制到所述的固有检查项中；重复执行步骤(4-1)，直到所有待检查的检查项在VBA文件中都有对应的检查模块；

(4-3)：对于在已经存在的VBA文件中没有的检查项，则根据检查内容建立新的检查模块，即形成所述的新定制检查项，重复执行步骤(4-1)，直到所有待检查的检查项在VBA文件中都有对应的检查模块。

2.根据权利要求1所述的一种电子文档的自动查错方法，其特征在于，包括以下步骤：

1)在所述VBA文件中设置：检查内容定义区、检查项模块区以及执行区,其中，

所述的检查项模块区，包括检查标记变量和定制的检查项对应的检查代码；

所述的检查标记变量包括用于表示检查种类的变量名和变量值；

所述检查内容定义区，用于显示所有定制的检查项，及定制的检查项的说明；

所述执行区，包括调用需要执行定制的检查项和将错误数据生成检查报告；

2)将所述的检查项模块区中的定制的检查项在所述的检查内容定义区中进行说明，也就是在所述的检查内容定义区中显示所有定制的检查项以及每个定制的检查项对应的标记变量名；

3)在所述的检查项模块区中，将所述定制的检查项按照检查流程形成检查代码，生成每个定制的检查项对应的检查模块；

4)在所述的执行区中，通过调用所述的检查项模块区中的变量名，对所述定制的检查项执行检查，并将出错的内容和出错的位置写入到所述检查报告中。

3.根据权利要求2所述的一种电子文档的自动查错方法，其特征在于，所述的变量值的初始值为“正确”，如果在检查过程中发现检查内容存在错误，则将变量值赋值为“待修改”；在执行步骤4)时，将所有变量值为“待修改”所对应的内容写入所述检查报告。

4.根据权利要求1所述的一种电子文档的自动查错方法，其特征在于，所述的电子文档是核电站仪控***中相关软件和硬件在测试阶段涉及的文档，所述文档为excel文件。

5.根据权利要求1所述的一种电子文档的自动查错方法，其特征在于，所述定制的检查项包括：页眉检查，所述的页眉检查定义为检查模块的步骤为：

(6-1)使用函数ActiveSheet.Name获取第一个工作表名称，作为当前工作表；

(6-2)使用函数GetHeadPageName获取所述当前工作表的页眉名称；

(6-3)使用函数StrComp对第一个工作表名称和当前工作表的页眉名称进行比较，如果名称一致，则检查下一个工作表，否则写入到检查报告中；

(6-4)如果当前工作表是最后一个工作表，则执行结束，否则取后一个工作表为当前工作表，获取工作表名称，并执行步骤(6-2)。

6.根据权利要求1所述的一种电子文档的自动查错方法，其特征在于，所述定制的检查项还包括单元格关联检查，所述的单元格关联检查定义为检查模块的步骤：

(7-1)设置关联列，所述关联列包括：第一关联列和第二关联列；

(7-2)设置关联规则为：(a)第一关联列的值为“通过”时对应第二关联列的内容为空，(b)第一关联列的值为“未通过”时对应第二关联列的内容为被测设备编号；

(7-3)使用函数ActiveWorkbook.Worksheets(i).Cells(j,k).Value获取当前工作表的第一关联列第一行的字段内容和第二关联列第一行的字段内容，作为当前工作表的当前行；其中，变量i表示第几张工作表，变量j表示工作表的第几行，变量k表示工作表的第几列；

(7-4)根据步骤(7-2)规定的规则，对步骤(7-3)获取的内容进行判断，如果符合关联规则(a)或(b)，则检查下一行数据，否则写入到检查报告中；

(7-5)如果当前行是最后一行，则执行结束，否则获取下一行为当前行对应的第一关联列的字段内容和第二关联列的字段内容，执行步骤(7-4)。

7.根据权利要求1所述的一种电子文档的自动查错方法，其特征在于，在步骤S3中，所述的逻辑处理包括采用循环、遍历的逻辑处理方法。

8.根据权利要求1所述的一种电子文档的自动查错方法，其特征在于，在步骤S4中生成的所述检查报告存储为能够在计算机上显示的文档，并将所述文档存储在计算机中。

9.根据权利要求8所述一种电子文档的自动查错方法，其特征在于，所述的检查报告格式为word文档、txt文档。