实验四 代码审查

Posted 2021-02-19 pxfa

一、实验目的

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

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

二、实验内容及要求

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

在项目早期就能够发现代码中的BUG

帮助初级开发人员学习高级开发人员的经验，达到知识共享

避免开发人员犯一些很常见，很普通的错误

保证项目组人员的良好沟通

项目或产品的代码更容易维护

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

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

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

代码是否遵循的编程规范

代码是否尽可能的模块化

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

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

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

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

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

  一些编码规范的检查工具如下，也可自行查找工具使用。本次实验使用eclipse的checkStyle插件来完成代码审查

三.实验过程

1.代码下载

1.1进入github直接下载即可

1.2遇见的问题：如果直接下载，那么可能会出现包用不了。因此可以适当调整代码位置。

1.3查阅资料得知eclipse可以直接导入Git连接，

方法如下：

       

eclipse中导入，选择git

 

 

 

 

选择分支

 

 

 

 

保存本地的路径

 

 

 

 

 

将项目加载到eclipse中

 

 

 

 

选择保存到本地的目录文件，自动加载pom.xml文件

 

编译maven项目

 

 

 

 

原文链接：https://blog.csdn.net/chyo098/article/details/79268136#commentsedit?utm_medium=distribute.pc_relevant.none-task-blog-baidujs-1

2.检查工具使用

    2.1 这次导入的git项目用java代码，老师推荐checkstyle 但是我认为fingbugs也有可以可用之处，此次代码审查，两种工具均使用到。

    2.2安装教程是在线安装，与fingbugs方法一致。见上次连接：https://www.cnblogs.com/pxfa/p/12637833.html

ps：此次未遇到error

3.使用工具对原始代码进行评审和分析

  大致的审查，分了类之后的结果如下：

The static field window.jPanel should be accessed in a
static way

 

 

 

 

 

This method has a constructor name

 

 

 

Missing Javadoc Method: 缺少 Javadoc 。

 

 

 

 

 

 

 - ‘if‘ 后应有空格。
    - ‘else‘ 缩进了8个缩进符，应为6个。
    - WhitespaceAround: ‘{‘ is not preceded with whitespace.

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

1是否正常工作:
2是，运行几次均没有错误

3代码是否遵循的编程规范：

4静态方法的调用不合理使用了某些不推荐使用的方法，如Thread.stop();

5静态方法的调用不合理

6使用了某些不推荐使用的方法，如Thread.stop();

7库引入不规范 ，引入了很多没有用到的库文件

8缩进不合理

 

5.提交issue

 

 

 

 

6.记录总结实验过程中遇到的问题和解决过程

  实验很顺利，程序没有什么大问题。