20180320作业2:进行代码复审训练
一、结对,找到一个伙伴进行结对;(在作业中标注自己的伙伴博客链接)
伙伴的博客链接:http://www.cnblogs.com/yyhhbb/p/8590591.html
二、各自对自己的伙伴上周进行的“单元测试”练习所完成的代码进行复审,形成“代码复审检查表”。
表1 代码复审检查表
概要部分 |
代码符合需求和规格说明么? |
符合 |
代码设计是否考虑周全? |
格式有点不规范 |
|
代码可读性如何? |
简单易懂 |
|
有冗余的或重复的代码吗? |
没有 |
|
代码的每一行都执行并检查过了吗? |
是的,都检查了 |
|
设计规范部分 |
设计是否遵从已知的设计模式或项目中常用的模式? |
是 |
有没有硬编码或字符串/数字等存在? |
有一部分 |
|
代码有没有依赖于某一平台? |
没有 |
|
有没有无用的代码可以清除? |
没有 |
|
代码规范部分 |
修改的部分符合代码标准和风格么? |
符合 |
具体代码部分 |
数据结构中有没有用不到的元素? |
没有 |
对于调用的外部函数,是否检查了返回值? |
是 |
|
效能 |
代码的效能(Performance)如何? |
良好 |
代码中,特别是循环中是否有明显可优化的部分 |
没有 |
|
可读性 |
代码可读性如何?有没有足够的注释? |
注释太多 |
可测试性 |
是否需要更新或创建新的单元测试? |
是 |
代码复审感想:通过复审队友的代码,发现他的代码基本符合代码风格规范:简单易懂无二义性。但 发现了需要注意几个细节:
1.有些程序设计语言的教科书对于基本的语法有详细的注释, 那是为了教学的目的, 不宜在正式项目中也这么做,应该把不必要的代码或代码注释清除掉;
2.由于该代码没有冗余无用的代码,其性能得到了很大的提升。