实验四 代码评审
一、实验目的
1) 了解代码审查的含义;
2) 掌握相关编程规范检查工具的安装与使用;
二、实验内容及要求
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、检查对象
仓库地址:https://github.com/yang828/Life-games
2、配置代码审查工具
使用Google代码规范工具Cpplint;
- Cpplint是一个python脚本,Google使用它作为自己的C++代码规范检查工具,VSCcode可配置Cpplint对C++代码进行规范检查;
下载并安装相关软件Cpplint,并使用。
3、使用工具对原始代码进行评审和分析,记录结果,期间不要有任何修改
对需要审查的代码进行评审,结果如下:
4、对工具执行结果进行人工分析,结合检查清单和人工走查的出代码修改建议
1、程序能否运行
需要下载graphics.h绘图,怎么样下载参考网络地址:https://www.360kuai.com/pc/9e29be7bf31eec889?cota=4&tj_url=xz&sign=360_57c3bbd1&refer_scene=so_1
2、是否有注释,并且描述了代码的意图
没有注释
3、修改建议
(1)行以空格结束,考虑删除这些额外的空格;
(2)空格和大括号要注意使用;
(3)分号后面缺少空格;
(4)缩进不规范;
(5)制表符的正确使用;
(6)操作符周围的空格丢失;
5、通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题,多个问题需放在多个issue中,以便跟踪。
在与同组成员商量后提交了相应的issue,并在后面进行了详细的问题阐述
6、记录总结实验过程中遇到的问题和解决过程
(1)不能熟练使用Google代码规范工具Cpplint;解决方法:在网上查找了cpplint的相关资料,加以理解。
(2)审查中的报错都是英文解释,需要来借用工具进行翻译。
四、实验小结
通过这次实验,我发现我们所编写的代码大多不符合代码规范,存在着种种细小的问题。然而这些问题在此次实验之前我们都没有注意到过。这次实验让我对代码规范有了一定的了解,也加强了小组的合作意识,对于软件工程的学习有了更深程度的理解。