软件工程 实验四@代码评审@

实验四@代码评审@
一、实验目的
1） 了解代码审查的含义；
2） 掌握相关编程规范检查工具的安装与使用；

二、实验内容及要求

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

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

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

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

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

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

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

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

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

三、实验过程

克隆我们所检查小组的仓库之后将克隆的文件导入eclipse：

(1)所使用的代码审查工具是eclipse Checkstyle插件 ，各类问题截图如下：

①

 

 修改建议：impoort前加空行。

②

修改建议：修改变量名，使符合规范。

③

public int a;
public int b;
public int n;均是如下截图问题

 

修改建议：调整缩进，制表符，修改变量名，使符合规范。

④

 

修改建议：字数过多，换行。

⑤

public void random()    、public int create() 、public static void main(String[] args)均是如下图问题

 

修改建议：增加Javadoc描述，调整缩进，制表符。

⑥

 

 修改建议：将变量的定义与声明放在同一行，调整缩进，制表符。

 ⑦

没有详细说明的问题，大都是行内含有制表符 tab 和缩进符的个数问题，数量过多，就不详细截图了。

 （2）程序运行正常

（3） 代码是尽可能的模块化

（4）代码有注释，且描写了代码的意图，但是不是很详细。

（5）issue 的提交

 

 

四 实验小结

　　通过这次代码审查，我发现我们所编写的代码大多不符合代码规范，如对缩进，变量的定义等细小的问题在未进行代码审查之前，我们都没有注意到过，所以，通过这次实验让我对代码规范有了一定的了解，相信对我以后编写代码时会有所帮助。