实验四: 代码评审

一、实验目的

1) 了解代码审查的含义;

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

二、实验内容及要求

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

三 实验内容

 

通过我们和下一个小组的沟通,我们了解到对面所用的编译语言为C++,我们在检测的过程中采用Cpplint脚本

 Cpplint是一个python脚本,VSCcode可配置Cpplint对C++代码进行规范检查,在网上搜索相关注意事项后,我们安装了该脚本。

  

  脚本下载及其安装

 

 

 

下载完成后进行配置

 

 

 

 

 

用cpplint工具检查代码

 

 

 

 

 

 

 接下来是手动检测代码,查看是否有遗漏

打开并运行

输入十道题目的数量,检测结果,以下随机输入错误答案,结果均为错误,程序大体功能可以实现。

 

 

 

 

接着抽取部分试题,输入正确结果,经过检验结果正确:

 

 

 

问题整理并反馈

 

 

 

 

 

实验小结

1、通过几个学期的学习,编写了很多程序,但是很少涉及代码规范性审查,很少帮助同学检查代码的规范性问题。通过实验我认识到,编码规范在项目协作中是可以直接影响到工作效率的。增强代码的可读性是很重要的事情。

2、对cpplint的使用很陌生,通过网络搜索,了解到一些相关的资料,熟练地掌握了一些对cpplin的基本运用。

3、审查的大部分问题都是缩进问题,通过这次实验让我明白,在以后的编写过程中能更加规范自己的代码,减少校对人员的麻烦,合理使用空格,增加代码的可读性。相比较tab键,空格键的使用会使得代码在不同开发环境下保持较为整齐的格式。

posted @ 2020-05-14 19:45  Alan与Python  阅读(448)  评论(1编辑  收藏  举报