实验四 代码评审

Posted 2020-12-19 yqw0710

一、实验目的

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.1确定所需要的代码审工具：

        在GitHub中先clone我需要进行审查的项目。根据克隆的项目，发现该工程使用的是JAVA语言，所以对应我选择使用eclipse Checkstyle插件 。

            

     1.2了解eclipse Checkstyle插件的安装及使用：

        我在百度浏览器中，学习了eclipse Checkstyle插件的安装教程，了解了基本安装方法。然后下载了eclipse 插件。

                 

      1.3根据安装教程，成功安装了Checkstyle，具体步骤为：

               

               

          其中一直点击next最后点击finish即可。

   注：看了很多方法的安装教程，相比较而言此安装方式是最简单的，也是最易于理解的。

      1.4安装成功显示：

            选中工程，右键可以看见：checkstyle。 点击Check Code with Checkstyle 可以进行代码审查。显示为：出现错误的代码背景为黄色，左边有一个放大镜。

                         

 

2、对代码简单阅读理解

     虽然代码审查没有对代码的理解得要求，但基于代码较为简单，我们之前在做结对编程时也是生命游戏，所以此代码理解起来很简单。而且我认为理解了代码对代码审查也是有一定帮助的。                                

LifeGame.java  1.初始化地图  2.打印此状态  While(){      3.计算下一状态      4.获得下一状态      5.打印下一状态 }

Methods.java check():计算下一状态 getNext():获得下一状态 printLifeMap():打印该状态

 1.初始化：对地图中的每个位置，利用Random随机赋值0或1。若为1，则为生："●"，否则为死： "○"。

 2.计算下一状态：遍历地图中的每个位置，计算周围8个位置活细胞的个数life。用point矩阵记录状态。

 3.获得下一状态：对地图进行遍历，对应的point矩阵中元素值为1，则地图该位置为死： "○"，否则point矩阵中元素值为0，则地图该位置为生："●"。

 4.打印状态：对地图进行遍历，输出每个位置的值。

 

 

 

 

 

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

    3.1用工具进行评审和分析：

        利用Checkstyle插件，点击Check Code with Checkstyle 进行代码审查。将鼠标放在放大器上，可以看见详细信息。例：

             

   3.2 记录结果：

        我们对审查出现的错误进行了汇总，包括：错误类型、具体的错误、数量及解决方式。检查清单如下：

           

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

     4.1人工分析：

              1.从上述检查清单中可以发现，审查出现大量的制表符和缩进不正确的问题，及较多的使用if语句缺少了{}的问题。

              2.参考Ckeckstyle常见报错的问题，相比较而言此代码出现的问题还不是很多，而且很多都不在常见问题之中。很多都是小问题，比如符号之间留有空格等。

     4.2修改意见：

              1.避免使用制表符；

              2.对注释和代码要有正确的缩进，比仅仅是代码对齐，要落实到规范化代码前面的空格数；

              3.注意大括号的使用。在大括号与其他符号相邻时，中间要留有空格；if语句即使只有一行，也需加{}；

              4.对自定义的变量，添加对应的javadoc注释；

              5.及时关闭使用的资源。

 

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

       根据检查清单，可以分为5个问题，所以共有5个issue。

            

       

           

 

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

 （1）.Java工程导入后，代码出现乱码。

       解决：在eclipse中设置对应的编码显示，或者把项目里的java文件都转为支持的编码。

           参考教程为：

              

           不知道为什么我按照方法3修改该工程的编码方式时，没有成功。之后我选择了方法1后，成功了。

            

   （2）.报错不完整

            我在看代码的时候发现，导入的这个模块没有用上，但是没有报错。

               

              我参考网上对checkstyle常见错误的分析中，发现导入未使用的类是会报错的，我怀疑是报错类型设置的不完整，但我找了很多资料，也没有找到相关解决方案。

                

    （3）.找不到checkstyle的报错汇总方法

            在学习通的视频中，用pylint对python代码进行审查时，结果可以进行自动汇总。例如：

              

              但是在eclipse中用checkstyle进行代码审查中，我没有找到汇总的方法（我想肯定是有的，只是我们还没有找到方法）。

            解决：我们小组进行了手动汇总，对出现的错误的类型、具体错误、出现数量及解决方案进行了汇总。

 

 四、实验总结

    1.根据此实验，我了解了代码审查工具的使用方法及功能，在eclipse中正确安装了Checkstyle工具，完成了对代码的审查与分析。

    2.在利用CheckStyle对Java代码审查，并汇总了错误后，我在其中也对编码规范有了更多的了解。虽然本次实验中出现的错误类型并不是很多，但我在查找相关资料的过程中也阅览了checkstyle常见报错的问题及解决，收获颇多。

    3.只有在真正亲自尝试后，代码审查留给我们的印象更为深刻，让我们在编辑代码的时候按照规范来写。也能让我们注意到平时注意不到的代码规范问题，比如：避免使用制表符，要及时关闭资源等。

    4.我对checkstyle的使用还不是很熟练，里面还有很多功能我还没有尝试，比如自定义编码规范等；而且我还没有找到对报错进行汇总的方法。

    5.我想我们小组之前写的代码，肯定也有很多不符合代码规范的地方。等别的小组对我们的代码提交issuse后，我们会返回去看自己的代码，发现自己存在的问题，在之后的编辑中，我们会多加注意，让自己编写的代码更加规范。

 

 参考资料：

     1.Checkstyle插件下载：https://sourceforge.net/projects/eclipse-cs/

     2.Checkstyle插件的安装教程：https://blog.csdn.net/LuXiuKang/article/details/81298549

     3.Checkstyle常见报错问题及解决：https://i.cnblogs.com/posts/edit;postId=12867156

 

小组代码审查过程记录：

       利用QQ中的屏幕分享，我们小组对代码审查中出现的错误进行了汇总，并提交了5个issuse。