Logiscope使用教程Word文档格式.docx
- 文档编号:20863961
- 上传时间:2023-01-26
- 格式:DOCX
- 页数:41
- 大小:1.19MB
Logiscope使用教程Word文档格式.docx
《Logiscope使用教程Word文档格式.docx》由会员分享,可在线阅读,更多相关《Logiscope使用教程Word文档格式.docx(41页珍藏版)》请在冰豆网上搜索。
OK,现在Logiscope可以在你的机器上正常运行了。
下面,我们就开始介绍Audit、RuleChecker、TestChecker这三项功能的使用。
首先是Audit。
2.2使用Audit
“Audit”——审查、检查的意思,Audit的功能与它的名字也很吻合,它用于审查代码的质量。
使用Audit来审查代码的质量分为两个步骤:
首先是建立被测程序的Audit项目,然后是分析Audit给出的质量审查结果。
下面对这两个步骤分别进行介绍。
2.2.1生成Audit项目
生成被测程序的Audit项目有两种方法。
2.1.1.1在Logiscopestudio中建立Audit项目
一种方法是:
在Logiscope的集成环境Logiscopestudio中,建立被测程序的Audit项目,这是推荐的方法。
步骤如下:
1、在开始菜单中,启动“Logiscopestudio”,进入Logiscopestudio环境。
Logiscopestudio启动后,如下图所示:
图2-4
Logiscopestudio环境
2、点击[File|New]菜单项,弹出如下图所示的对话框:
图2-5新建项目
在对话框中,选中“Project”标签页,在列表框中我们选择“C++
AuditProject”这一项,然后在“Project”编辑框中添入你要建立的这个Audit项目的名字(可以取任何你喜欢的名字),再在“Locatior”编辑框中,选择一个存放将要生成的Audit项目的文件目录。
最后点击“确定”按钮。
3、此时会弹出如下图所示的对话框:
图2-6
新建项目向导
在对话框的“Applicationroot”编辑框中,添入你所要检测的源程序文件所在文件夹的路径,其它均采用默认设置,然后点击“下一步”按钮。
4、弹出如下图所示的对话框:
图2-7新建项目向导
在该对话框中,使“Chooseaparser”组合框保持“MFC”默认选项,在“Chooseaquality”编辑框中,添入我们所设计的质量模型文件的存放路径(Logiscope默认选择的是LogiscopeHOME\Logiscope\Ref\Logiscope.ref下的这个质量模型文件),Logiscope要依照该文件对被审查的代码进行检测。
在“ChooseaLogiscope”编辑框中为生成的Logiscope中间结果文件选择一个存放路径,一般使用当前提供的默认路径即可,最后点击“下一步”按钮。
5、弹出如下图所示的对话框:
图2-8新建项目向导
这个对话框,是在向你汇报将要生成的Audit项目的相关情况,没有什么需要编辑、设置的地方。
点击“完成”按钮。
至此,生成了一个Audit项目,显示窗口如下:
图2-9新建项目结束
在该窗口中,选择[Project|Build]菜单项,Audit开始对被测代码进行检测。
Build执行结束后,代码质量的检测结果也就产生了,进行保存。
2.2.1.2在VisualStudio中建立Audit项目
除了上面这个建立被测代码Audit项目的方法外,你也可以在VC6.0的集成环境中建立被测程序的Audit项目(但有时会发生出错,所以,建议你还是在Logiscopestudio中建立被测程序的Audit项目)。
在VC6.0的环境中建立Audit项目的步骤如下:
启动VC6.0,打开你要检测的项目,选择[Tools|BuildQualityResults]菜单项,Build结束后,选择[Tools|Viewer]菜单项,此时,Logiscope被启动,Audit对代码质量的检测结果会显示在你的面前。
注意:
只有你已经将Logiscope的功能集成到VC6.0的开发环境中去,才可以使用这个方法。
将Logiscope功能集成到VC6.0开发环境中的方法为:
Logiscope安装成功后,点击开始菜单,启动“程序|TelelogicTauLogiscope|Utilities|VisualIntegration”,在弹出的对话框中点击“Install”按钮即可。
2.2.2查看检测结果
前面已经讲述了建立被测程序Audit项目的方法,既然检测结果已经得到了,我们现在就说一下如何查看、分析Audit对被测程序的这些检测结果。
选择[Browse|Quality|FactorLevel]菜单项,Logisciop会显示Audit对所检测源程序质量水平的评价结果,评价结果包括系统的质量、类的质量、函数的质量。
如下图所示:
图2-10质量水平
选择[Browse|Quality|CriteriaLevel]菜单项,Logisciop会显示Audit对所测源程序的各项质量标准的检测结果,具体包括:
系统的质量标准、类的质量标准、函数的质量标准。
图2-11质量标准
选择[Browse|Quality|QualityReport]菜单项,可生成网页风格的系统质量评价报告。
图2-12质量评价报告
以上这些是Audit对被测试代码在质量因素级、质量标准级上的检测信息,关于系统、类、函数在质量度量级上的检测信息,需要选择[Project|StartViewer]菜单项,通过启动“LogiscopeViewer”来进行查看。
我们现在就启动“LogiscopeViewer”来看一下。
LogiscopeViewer被启动后,界面如下所示:
图2-13
Viewer
Viewer中的列表控件中,显示了系统中的全部函数。
选中某个函数后,通过点击下面这个工具条上的按钮,可以查看Audit为我们提供的对函数的各种分析信息。
工具条及工具条上各个按钮的功能如下:
图2-14函数分析信息工具条
点击工具条上的相应按钮,会分别显示如下的信息:
点击函数流程图按钮,会显示函数的流程图:
图2-15函数流程图
此时,选择[Options|FullReduction]或[Options|Step-by-StepReduction]菜单项,可对流程图进行结构化的转换,选择[Options|Initial]还原。
点击函数度量元按钮,会显示函数的度量元检测结果:
图2-16函数度量元
点击函数质量标准按钮,会显示函数质量标准的检测结果:
图2-17函数质量标准
点击函数调用关系按钮,会显示函数之间的调用关系的检测结果:
图2-18函数调用关系
点击系统度量元按钮,会显示系统度量元的检测结果:
图2-19系统度量元
以上显示了函数域、系统域的情况,我们还可以查看各个类的情况。
在Viewer中点击[File|New]菜单项,在弹出的对话框中选中“ClassWorkspace”,如下图所示,点击确定按钮。
图2-20新建ClassWorkspace
这时,界面显示如下:
图2-21
ClassWorkspace
窗口的列表框中列出了系统中所有的类。
选中某个类后,点击下面这个工具条上的按钮,可以查看关于该类的各种分析信息。
工具条及各个按钮的功能如下:
图2-22
ClassWorkspace工具条
点击工具条上的各个按钮,会分别显示如下的信息:
点击类度量元按钮,会显示类度量元的检测结果:
图2-23类度量元
点击类质量准则按钮,会显示类质量准则的检测结果:
图2-24类质量准则
点击类派生关系按钮,会显示父类、子类之间的派生关系:
图2-25类派生关系
点击类使用关系按钮,会显示类与类之间的使用关系:
图2-26类使用关系
2.3使用RuleChecker
RuleChecker是Logiscope的另一个功能,它是一个静态、白盒性质的测试工具,用来检查代码书写规范性。
使用RuleChecker来检查代码的规范性分为两个步骤:
首先是建立被检测代码的RuleChecker项目,然后是分析RuleChecker给出的代码书写规范性检测结果,得出报告。
2.3.1建立RuleChecker项目
介绍两种建立RuleChecker项目的方法。
2.3.1.1在Logiscopestudio中建立RuleChecker项目
建立步骤:
1、启动Logiscopestudio,进入Logiscopestudio的环境后,点击[File|New]菜单命令。
2、弹出对话框,如下图所示:
图2-27新建RuleChecker项目
选中“Project”标签页后,在列表框中我们选择“C++RuleChecker
Project”这一项,然后在“Project”编辑框中添入你要建立的这个RuleChecker
项目的名字(你可以取任何你喜欢的名字),再为“Locatior”编辑框选一个存放将要生成的RuleChecker
项目的文件目录。
3、弹出对话框,如下图所示:
图2-28新建RuleChecker项目向导
在“Applicationroot”编辑框中添入你所要检测的源程序文件的存放路径。
然后点击“下一步”按钮。
4、弹出对话框,如下图所示:
图2-29新建RuleChecker项目向导
使“Chooseaparser”组合框保持默认选项,在“ChooseaConfigurationfile”编辑框中添入我们所设计的规则集文件(如果不设置,则Logiscope为我们默认选中TestChecker提供的规则集文件,该文件的路径在“LogiscopeHOME\Logiscope\data\audit_c++\RuleChecker.cfg”),其它均采用默认值即可。
点击“下一步”按钮。
5、弹出对话框,如下图所示:
图2-30新建RuleChecker项目向导
这是在向你汇报将要生成的RuleChecker项目的一些情况,点击“完成”按钮,生成一个RuleChecker项目,显示如下:
图2-31RuleChecker界面
选择[Project|Build]菜单命令,RuleChecker开始扫描程序代码。
Build执行成功之后,检测结果也就产生了。
2.3.1.2在VisualStudio中建立RuleChecker项目
除了上面的方法外,你也可以在VC6.0的环境中建立RuleChecker项目,但比在Logiscopestudio中多一些限制(我建议你还是在Logiscopestudio中建立被测程序的RuleChecker项目)。
在VC6.0的环境中建立RuleChecker项目的步骤如下:
启动VC6.0,打开你要检测的程序的.dsw文件,选择[Tools|CheckRules]菜单命令,RuleChecker开始扫描程序代码,检测代码的书写规范性。
操作执行成功之后,选择[Tools|viewer]菜单命令,Logiscope被启动,检测结果会显示在你的面前。
2.3.2查看检测结果
上面介绍了如何建立被检测代码的RuleChecker项目,并生成检测结果。
检测结果有了,现在说一下如何查看检测结果。
选择[Browse|Rule|RuleViolations]菜单命令,RuleChecker会在树状视图中列出代码中所有违反编码规范的地方,如下图所示:
图2-32RuleChecker界面
在树状视图中共有三个文件夹——ViolatedRules文件夹、CleanRules文件夹、IgnoredRules文件夹。
其中,ViolatedRules文件夹罗列出了代码未遵守的编码规范;
CleanRules文件夹罗列出了代码遵守的编码规范;
IgnoredRules文件夹罗列出了在本次检测中忽略的编码规范。
各文件夹展开后,如下图所示:
图2-33树状视图
我们主要看的就是ViolatedRules这个文件夹中的内容。
展开ViolatedRules文件夹后,显示了在代码中未遵守的各项编码规范,每个规范都以一个交通灯的图标显示。
用鼠标双击这个图标,RuleChecker会显示对这条编码规范的解释,如下图所示:
图2-34编码规范解释
用鼠标单击图标将其展开,会列出违反该项编码规范的源文件的文件名,再向下展开,会显示在该文件中违反该编码规范的代码的行号,如下图所示:
图2-35违反编码规范的位置
用鼠标双击这个行号,RuleChecker会显示源文件,并将光标定位到违反该规范的代码行处,如下图所示:
图2-36定位违反编码规范的代码
对RuleChecker检测信息的查看,基本就是这些。
还有值得说一下的是,我们可以人工的开启、关闭某些编码规范。
方法是:
点击[Prtoject|Settings...]菜单命令,启动如下的一个对话框:
图2-37开启、关闭某些编码规范
注意到对话框最下面的那个列表框了吗?
列表框中列出了RuleChecker提供的所有编码规范,当其前面的复选框是选中状态时,则该规范在RuleChecker检测过程中生效,当其前面的复选框是未选中状态时,则该规范在RuleChecker检测过程中不生效。
你可以根据具体情况,使某些前面生效,或不生效。
设置完成后,点击“确定”按钮,保存设置。
然后选择[Project|Build]菜单命令,重新让RuleChecker扫描代码。
Build结束后,与你设置相符的检测结果产生,查看的方法和前面是一样的。
点击[Browse|Rule|RuleViolationsReport]菜单命令,会生成RuleChecker的检测报告。
图2-38检测报告
报告是以网页的形式提供的,查看起来很方便。
报告分两部分。
第一部分分别以源文件为单位和以编码规范为单位,将检测结果以表格的形式显示了出来。
第二部分,给出了所有编码规范的解释说明。
2.4使用TestChecker
TestChecker是一个白盒、动态测试工具,用于统计被测试程序的测试覆盖率。
TestChecker重点统计的覆盖率是边覆盖率,也叫判定到判定的覆盖。
使用TestChecker统计被测试程序的测试覆盖率分为两个步骤:
首先是建立被测程序的TestChecker项目;
然后,在TestChecker环境中运行被测程序,执行测试用例,TestChecker会给出执行测试用例后的覆盖率。
2.4.1建立TestChecker项目
要建立一个TestChecker项目,需要在两方面进行操作,一个是在VisualStudio环境中,一个是在LogiscopeStudio环境中。
下面介绍建立一个TestChecker项目的步骤。
2.4.1.1在VC6.0中进行设置
1)用VC6.0打开你要测试项目的.dsp或.dsw文件。
2)VC6.0启动后,选择[Build|Configurations]菜单命令。
3)点击“Add”按钮,在项目中添加一个名为“Logiscope”的文件夹。
如图所示:
图2-39添加文件夹对话框
4)点击“OK”按钮,最后的结果如下:
图2-40配置文件夹对话框
点击“Close”按钮退出对话框。
5)选择[Build|SetActiveConfiguration]菜单命令,选中“Logiscope”这一项,如图:
图2-41设置当前文件夹对话框
点击“OK”按钮退出对话框。
6)选择[Project|Settings]菜单命令。
我们要在VC6.0的Settings中进行一些设置。
7)设置“C/C++”标签页。
选中“C/C++”标签页,在“Category”组合框中选中“Preprocessor”,在“Additionalincludedirectories”编辑框中添入你电脑上Logiscope的Include文件夹的路径,该文件夹的路径为:
Logiscope安装目录\Logiscope\instr\include。
在我电脑上的设置结果如下图所示:
图2-42Setting对话框
8)设置“LINK”标签页。
切换到“LINK”标签页,在“Object/librarymodules”编辑框中添入vlgtc.lib。
如下图所示。
图2-43Setting对话框
然后,在“Category”组合框中选中“Input”,在“Additionallibrarypath”编辑框中为上面这个lib文件指定路径,路径为“Logiscope安装目录\Logiscope\instr\lib”。
在我电脑上的设置情况如下图所示:
图2-44Setting对话框
点击“OK”按钮。
9)选择[Project|ExportMakefile…]菜单命令,
图2-45生成.mak文件对话框
选中列表框中的项目后,点击“OK”按钮。
10)选择[File|SaveAll],保存我们所做的一切设置。
至此,在VC6.0中对被测程序的设置全部完成了。
退出VC6.0,启动“Logiscopestudio”,进入Logiscopestudio环境,开始插装被测程序。
2.4.1.2在LogiscopeStudio中插装被测程序。
1)启动LogiscopeStudio后,选择[File|New]菜单命令,弹出下面的对话框:
图2-46新建TestChecker项目对话框
在“Projects”列表框中选中“C++TestCheckerProject”,在“Project”编辑框中为你要建立的TestChecker项目取一个名字(可以取任何你喜欢的名字)。
在“Location”编辑框中,为这个新建立的TestChecker项目指定一个存放路径。
点击“确定”。
2)弹出下面的对话框:
图2-47新建TestChecker项目向导
在“Applicationroot”编辑框中,指出你所要测试项目的.dsw文件的路径。
点击“下一步”。
3)弹出下面的对话框:
图2-48新建TestChecker项目向导
对话框中的各项内容全部采用默认的设置,点击下一步。
4)弹出下面的对话框:
图2-49新建TestChecker项目向导
在“Chooseamakecommand”编辑框中写入makelog.bat。
点击下一步。
5)弹出下面的对话框:
图2-50新建TestChecker项目向导
点击完成,会有如下的显示:
图2-51建立TestChecker项目
6)删除resource.h文件。
在“workspaceview”中,用鼠标左键选中resource.h文件,按delete键将其删除。
图2-52删除resource.h文件
7)编写makeLog.bat文件。
在与被测试项目的.dsw文件同一目录下,新建一个文本文件,在文件中写入如下的内容:
callC:
\programfiles\microsoftvisualstudio\vc98\bin\vcvars32.bat
nmake/A/FABCD.makCFG=ABCD-Win32Logiscope
(注意:
所有的字符都应为英文字符)
其中:
第一行的“C:
\programfiles\microsoftvisualstudio\vc98\bin\vcvars32.bat”,指定的是VC6.0安装目录下的vcvars32.bat文件的路径,如果你的vcvars32.bat不是安装在这个目录下,请你用你的vcvars32.bat文件的安装路径替换这个路径。
第二行的ABCD,要替换为你所测的项目的名字。
在确保该文件的内容正确后,保存文件,并将文件重命名为makeLog.bat。
8)选择[Project|Bulid]菜单命令,TestChecker开始编译连接程序代码,生成可执行程序。
9)执行了上一步的操作后,会在你所测项目的Logiscope文件夹下生成一个exe文件。
选择[Project|Settings]菜单命令,在弹出的对话框中选中“TestChecker”标签页。
图2-53TestCheckerSe
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Logiscope 使用 教程