Code Review的一些典型内容

如下是Code Review中一些典型的内容：

一、常规项：

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

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

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

4、是否存在多余的或者重复的代码？

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

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

7、是否有被注释掉的代码？

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

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

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

二、安全：

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

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

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

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

三、文档：

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

2、所有的函数都有注释吗？

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

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

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

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

四、测试：

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

2、是否存在测试，它们是否可以被理解？比如，至少达到你满意的代码覆盖(code coverage)。

3、单元测试是否真正的测试了代码是否可以完成预期的功能？

4、是否检查了数组的“越界“错误？

5、是否有可以被已经存在的API所替代的测试代码？