实验四 代码评审

一、实验目的

1、了解代码审查的含义；

2、掌握相关编程规范检查工具的安装与使用；

二、实验内容及要求

Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量，通过代码评审可以达到如下目的：

  • 在项目早期就能够发现代码中的BUG
  • 帮助初级开发人员学习高级开发人员的经验，达到知识共享
  • 避免开发人员犯一些很常见，很普通的错误
  • 保证项目组人员的良好沟通
  • 项目或产品的代码更容易维护

     代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误，提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识，可是很多时候并未被有效执行，甚至被认为是一项费时费力的工作。借助一些工具可以更容易，更有效率地来进行Code Review。

1、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查以下情况。你也可有查询相关材料，建立更细化的检查清单（check list）

- 程序是否能正常工作，代码是否实现预期的功能，逻辑是否正确。

- 代码是否遵循的编程规范

- 代码是否尽可能的模块化

- 所有的数据输入是否都进行了检查

- 是否有注释，并且描述了代码的意图

- 代码的可理解性和可测试性

2、按“实验二”的分组方式，两人一组，随机分配另一组的代码作为本组评审和分析的对象

一些编码规范的检查工具如下，也可自行查找工具使用。

java语言      

- 采用使用eclipse Checkstyle插件 

- CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名，方法体的最大行数，重复代码检查等等。

如果你使用idea ，可以使用Alibaba Java Code Guidelines插件，参考链接如下：https://github.com/alibaba/p3c/wiki/IDEA%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3

C++语言

- 可使用Google代码规范工具Cpplint。

- Cpplint是一个python脚本，Google使用它作为自己的C++代码规范检查工具，VSCcode可配置Cpplint对C++代码进行规范检查。

python

- 可采用pylint

- Pylint 是一个 Python 代码分析工具，它分析 Python 代码中的错误，查找不符合代码风格标准（Pylint 默认使用的代码风格是 PEP 8，具体信息，请参阅参考资料）和有潜在问题的代码。目前在 eclipse 的 pydev 插件中也集成了 Pylint，VSCcode可安装pylint插件

    当发现了项目存在的问题后，可通过Bug跟踪系统向项目维护者反馈问题（issue）,管理Issue的系统称为BTS（Bug Tracking System，Bug跟踪系统）。当今具有代表性的BTS有Redmine、Trac、BugZilla等。GitHub自身也加入了BTS的功能。在GitHub上，可以将它作为软件开发者之间的交流工具。通过github的issues功能开发者可以便捷的发现软件的BUG并报告，想向项目所有人询问或用来追踪各种想法探讨准备实施的任务。

三、实验过程

1、配置代码审查工具。要求采用屏幕截图的方式配置的过程；

（1）首先在找到我们要评审小组代码的语言。为C++语言，那么就要下载Cpplint对C++代码进行规范检查。

  • 从http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py  下载cpplint.py源码，并将其存放到D:\python-2.7中；

  • 从https://www.python.org/ 下载python-2.7.10.msi；

  •  安装python，并将D:\ProgramFiles\Python2.7 添加到系统环境变量中；

 

（2）将评审代码克隆在自己的E盘，文件路径为，E:\git_project中。

 

2、使用工具对原始代码进行评审和分析，记录结果，期间不要有任何修改；

（1）对代码进行评审得到以下结果。

 

      经过查阅，对以下说明作出解释：

  • 对于发现的每一个问题，cpplint都会给出一个位于区间[1, 5]之间的置信度评分，分数越高就代表问题越肯定，能够通过verbose选项控制输出哪些级别。例如以下。置信度评分为1、2的将不会再输出：D:\python-2.7>python Cpplint.py --verbose=3 test.cpp
  • 假设代码中有些部分不希望被检查，或者觉得是cpplint产生的误报。仅仅须要在对应代码行尾加入凝视”// NOLINT”就可以，cpplint就会跳过这些行。如：return 0; // NOLINT
  • 假设须要让cpplint支持其他文件扩展，又不想改动源代码。则能够通过extensions选项如：D:\python-2.7>python Cpplint.py --extensions=hpp test.cpp
  • 能够指定错误信息输出格式，支持两种格式，默认是emacs格式。还支持Visual Studio格式，能够通过output选项指定。如：D:\python-2.7>python Cpplint.py --output test.cpp 2>log.txt
  • 能够通过filter选项。依照自己的须要过滤掉特定的警告，”-FOO”表示不输出带有FOO的警告，”+FOO”表示输出带有FOO的警告，如：D:\python-2.7>python Cpplint.py --filter=-whitespace/tab,+whitespace/ending_newline test.cpp
  • 能够通过counting选项。来显示每种Category有多少个错误，如：D:\python-2.7>python Cpplint.py --counting=detailed test.cpp
  • 能够通过linelength选项。来控制每行的最长长度，默认是80字符。假设同意每行最长长度为120，则为：D:\python-2.7>python Cpplint.py --linelength=120 test.cp

（2）设置输出各类问题和总数，得到了所有问题的种类和出现的次数。

 

3、对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议；

经过分析我们对评审代码出现的提示进行一下分析以及提出了修改建议。

 

4、通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题，多个问题需放在多个issue中，以便跟踪；

对作者的仓库提交issue。

 

四、实验小结

1、本次实验使用了Cpplint对代码进行审查，注意的是一个python脚本，Google使用它作为自己的C++代码规范检查工具，而不是一个具体的插件不需要进行安装。

2、通过本次实验我明白了及时程序可以正常运行也不能说明这个程序就是完美的，代码是否遵循的编程规范是最常见的问题，也是很细节的东西，涉及的方面也很广很多，只能通过实践与多多练习才能减少编程不规范的情况的发生。

3、在实验最后我们也对自己的代码产生了好奇心，想知道我们有哪些不规范的错误，所以也对自己的代码进行了评审，也看见了我们编程时没有考虑到的很多方面的问题，并且进行了修改，通过大致的总结我们的印象更加深刻。

 

posted @ 2020-05-14 11:14  阿X  阅读(165)  评论(0)  编辑  收藏  举报