代码复审

       因为所学的<JAVA软件设计模式>课上,有大作业挑选一种设计模式进行实例设计.在设计好代码后(桥接模式)我和同伴对其根据以下几个方面进行了代码的复审

 

常规项

· 代码能够工作么？它有没有实现预期的功能，逻辑是否正确等。

· 所有的代码是否简单易懂？

· 代码符合你所遵循的编程规范么？这通常包括大括号的位置，变量名和函数名，行的长度，缩进，格式和注释。

· 是否存在多余的或是重复的代码？

· 代码是否尽可能的模块化了？

· 是否有可以被替换的全局变量？

· 是否有被注释掉的代码？

· 循环是否设置了长度和正确的终止条件？

· 是否有可以被库函数替代的代码？

· 是否有可以删除的日志或调试代码？

安全

· 所有的数据输入是否都进行了检查（检测正确的类型，长度，格式和范围）并且进行了编码？

· 在哪里使用了第三方工具，返回的错误是否被捕获？

· 输出的值是否进行了检查并且编码？

· 无效的参数值是否能够处理？

 

文档

· 是否有注释，并且描述了代码的意图？

· 所有的函数都有注释吗？

· 对非常规行为和边界情况处理是否有描述？

· 第三方库的使用和函数是否有文档？

· 数据结构和计量单位是否进行了解释？

· 是否有未完成的代码？如果是的话，是不是应该移除，或者用合适的标记进行标记比如‘TODO’？

测试

· 代码是否可以测试？比如，不要添加太多的或是隐藏的依赖关系，不能够初始化对象，测试框架可以使用方法等。

 

        在完成复审后,我们充分了解到了代码复审的复杂繁琐,当然更多的是重要性.如上文中的"· 是否有被注释掉的代码？"这一条让我印象深刻.这简单甚至是傻瓜化的错误使得程序在我们多次查找语法错误之后任然无法编译成功.

 不能两次踏入同一条河流，程序员不能两次犯同样的错误。在代码复审后，我们应该把复审过程中的记录整理出来：

（1）更正明显的错误。

（2）对于无法很快更正的错误，要把它们记录下来。

（3）把所有的错误记在自己的一个“我常犯的错误”表中，作为以后自我复审的第一步。