一、引言
软件在开发过程中如何保证代码质量?仅凭个人能力去检视判定,效率太低,而且和个人能力有很大关系,如果能有一些小工具来协助,岂不是如虎添翼?
本文就是介绍CppCheck和SourceMonitor两个小工具的安装和使用,在我们软件开发过程中,帮助我们去检查、规范、重构、总结我们的代码,有利于个人能力提升,有利于软件开发质量的保证和提高。
本文不介绍这两个工具是什么,以及有什么用处;而是介绍如何安装配置到我们日常使用的IDE中,如何方便有效的使用。
二、CppCheck安装
CppCheck下载,自行选择32位还是64位版本下载。下载完之后进行安装,默认安装即可。
安装完成之后,进入安装目录。
可以看到有cppcheck.exe和cppcheckgui.exe。做Qt开发的软件工程师,是不是很惊讶地发现了还有Qt5的动态链接库。
cppcheck.exe: 用于命令行使用,可以在命令行上执行cppcheck.exe -h,查看参数
cppcheckgui.exe: 带界面的cppcheck,是的,就是用Qt5开发的
cppcheck的使用手册下载cppcheck_manual.pdf,需要深入了解cppcheck的可以参考此文档。甚至想了解此工具源码的可以自行去网上搜索找到,或者联系我。
三、SourceMonitor安装
SourceMonitor下载,默认安装,进入安装目录。
SourceMonitor.exe: 用于命令行使用
SourceMonitor.chm: 帮助文档
四、Source Insight 上配置使用 CppCheck 和 SourceMonitor
1、Source Insight 上配置使用 CppCheck
- 选择菜单栏Tools–>Custom Commands
- 点击Add
- 输入New command name,例如CppCheck,然后点击OK按钮
- 然后在Run:输入框中输入,‘“C:\Program Files (x86)\Cppcheck\cppcheck.exe” –enable=all %f’,注意替换成你自己的CppCheck安装路径,%f指当前文件
- 勾选Capture Output
- 点击Keys,进入快捷键设置界面
- 直接使用快捷键,然后就会显示出你所按下的快捷键。注意最好不要和其他快捷键有冲突,我的是Alt+2,点击OK
然后测试一下自己的配置,打开一个文件fotaupdate.c,快捷键Alt+2
然后在上面tab页面,生成了一个CppCheck(Final)的临时文档,这个文档详细列出了检测结果。
2、Source Insight 上配置使用 SourceMonitor
- 选择菜单栏Tools–>Custom Commands
- 点击Add
- 输入New command name,例如SourceMonitor,然后点击OK按钮
- 然后在Run:输入框中输入,‘“C:\Program Files (x86)\SourceMonitor\SourceMonitor.exe” /DC %f’,注意替换成你自己的SourceMonitor安装路径,/DC指C语言文件,如果是C++文件则是/DC++,具体信息参看SourceMonitor帮助文件。
- 点击Keys,进入快捷键设置界面
- 直接使用快捷键,然后就会显示出你所按下的快捷键。注意最好不要和其他快捷键有冲突,我的是Alt+1,点击OK
- 一定注意与配置CppCheck的不同之处!!!
然后测试一下自己的配置,打开一个文件fotaupdate.c,快捷键Alt+1。
会在电脑任务栏上生成一个SourceMonitor的图标,点击图标,则可以看到对此文件检测的详细信息。
五、Qt Creator 上配置使用 CppCheck 和 SourceMonitor
1、Qt Creator 上配置使用 CppCheck
- 点击菜单栏工具–>外部–>Configure–>外部工具
- 点击添加–>添加工具
- 重命名工具名为CppCheck,按照截图输入对应参数
- 点击Apply,点击OK
然后测试一下自己的配置,打开一个工程,选中工程文件,选择工具–>外部–>CppCheck
2、Qt Creator 上配置使用 SourceMonitor
- 点击菜单栏工具–>外部–>Configure–>外部工具
- 点击添加–>添加工具
- 重命名工具名为SourceMonitor,按照截图输入对应参数
- 点击Apply,点击OK
然后测试一下自己的配置,打开一个工程,打开一个源文件,选择工具–>外部–>SourceMonitor。然后会生成此文件的详细信息、
六、VS 2013 上配置使用 CppCheck 和 SourceMonitor
1、VS 2013 上配置使用 CppCheck
- 点击菜单栏工具–>外部工具
- 点击添加按钮,标题上输入CppCheck
- 命令输入:CppCheck安装目录
- 参数输入:–enable=all –quiet –verbose –template=vs $(SolutionDir)
- 初始目录输入:$(ItemDir)
- 勾选使用窗口输出
- 点击应用,点击确定
然后测试一下自己的配置,打开一个工程,选中工程文件,选择工具–>CppCheck,然后会在输出窗口上输出信息。
2、VS 2013 上配置使用 SourceMonitor
- 点击菜单栏工具–>外部工具
- 点击添加按钮,标题上输入SourceMonitor
- 命令输入:SourceMonitor安装目录
- 参数输入:/DC++ $(ItemPath)
- 初始目录输入:$(ItemDir)
- 点击应用,点击确定
然后测试一下自己的配置,打开一个工程,选中一个源码文件,选择工具–>SourceMonitor,然后会生成此文件的详细信息。
七、总结
1、对两个工具的研究并没有非常深入,所以此文档难免有浅显、疏漏之处。
2、如何使用工具不是目的,目的是最后输出的结果。为了不让大家在如何使用工具上浪费时间,特写此文档,方便大家。
3、如果在使用配置过程中,还有什么疑问的话,请联系作者,一起研究学习。