20180320作业2:进行代码复审训练

代码复审核查表 

概要部分

代码符合需求和规格说明么?

基本符合

代码设计是否考虑周全?

代码可读性如何?

一般

代码容易维护么?

容易

代码的每一行都执行并检查过了吗?

设计规范部分

设计是否遵从已知的设计模式或项目中常用的模式?

有没有硬编码或字符串/数字等存在?

代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到Win64)

开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?

有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码。)

代码规范部分

修改的部分符合代码标准和风格么(详细条文略)?

符合

具体代码部分

有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?

参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?

无,字符,以0开始

边界条件是如何处理的?Switch语句的Default是如何处理的?循环有没有可能出现死循环?

有没有使用断言(Assert)来保证我们认为不变的条件真的满足?

对资源的利用,是在哪里申请,在哪里释放的?有没有可能导致资源泄露(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有可能优化?

在主函数创建对象,进行调用函数,判断结束后释放资源

数据结构中是否有无用的元素?

效能

代码的效能(Performance)如何?最坏的情况是怎样的?

一般,判断出错,输出错误信息

代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中string的操作是否能用StringBuilder来优化)?

对于系统和网络调用是否会超时?如何处理?

不会,无处理

可读性

代码可读性如何?有没有足够的注释?

可测试性

代码是否需要更新或创建新的单元测试?针对特定领域开发(如数据库、网页、多线程等)的核查表。

不需要

代码复审感想:

代码不仅仅是要实现相应功能,而且要简洁、规范,要适当做注释,以便可读可维护。编写代码最难的是如何在能实现相应功能基础上进行代码优化。

  小伙伴的博客链接:http://www.cnblogs.com/chessman/p/8586613.html

你可能感兴趣的:(20180320作业2:进行代码复审训练)