实验四 代码评审

Posted 2020-12-20 blog-address

一、实验目的

1） 了解代码审查的含义；
2） 掌握相关编程规范检查工具的安装与使用；

 

二、实验内容及要求

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

●在项目早期就能够发现代码中的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.1 确定代码审查工具

    进入github页面克隆需要审查的项目，根据README.md文件可知是java项目，因此使用的工具是eclipse Checkstyle插件。

 

 

1.2 eclipse Checkstyle的下载安装

• 下载checkstyle离线安装包，网址为：http://sourceforge.net/projects/eclipse-cs

• 下载完成后将压缩包中features文件夹和plugins文件夹的复制到eclipse中的根目录中进行覆盖

• 打开eclipse，Window-->Preferences,如果列表中出现了checkstyle的菜单，则表示安装成功了

 

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

    一开始使用checkstyle审查项目无结果，发现项目其实并没有成功导入eclipse，之后是怎么都到不进来，于是又去了对方仓库查看README.md文件，才知道对方使用idea编写的程序，询问了我的队友，最终采取了他的意见，在eclipse下新建一个java项目，再导入对方的test文件，运行结果如下图。

 

 

• 现在可以开始审查啦，选中想要审查的项目右击点击checkstyle,选择check code with checkstyle

 

 

•  将鼠标放在放大器上查看详细信息

 

• 记录结果

序号	错误类型	数量	解决方法
1	代码缩进不正确	85	删除多余空格，在应该换行的地方一定要换行
2	函数导入错误	15	具体导入，不要直接使用“.*”

 

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

    见上表

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

    查看对方仓库发现大部分问题队友已经提交issue啦，于是我只稍作添加

 

（5）记录总结实验过程中遇到的问题和解决过程

    有一部分问题前面已经描述过这里就不再重复啦，还有一个问题就是在线安装checkstyle时报错，如下图所示，一直装不上，后面我就改用离线的方法安装了，安装过程前面也有说明希望可以帮助到遇到同样问题的朋友。

 

    还有一个小问题就是对方的项目文件藏得很深，不是很理解这种布局，好在写了说明文档，查阅文档真的是非常有必要的。

 

实验小结

    本次实验审查下来发现最多的就是代码缩进问题，以前从没有注意过代码的缩进，很多时候为了让代码显示的美观和清晰我经常会多空几个空格之类（除了python，因为python靠缩进来辨别语句），但这些都是不符合规范的，了解了checkstyle，以后编写程序我会使用它，让自己的代码可以编写的更加规范。