看到一篇文章写了关于code Review 的文章,觉得很有意思,开发应该注意到的一些审查项
以下摘自
http://blog.jobbole.com/83595/
常规项
代码能够工作么?它有没有实现预期的功能,逻辑是否正确等。所有的代码是否简单易懂?代码符合你所遵循的编程规范么?这通常包括大括号的位置,变量名和函数名,行的长度,缩进,格式和注释。是否存在多余的或是重复的代码?代码是否尽可能的模块化了?是否有可以被替换的全局变量?是否有被注释掉的代码?循环是否设置了长度和正确的终止条件?是否有可以被库函数替代的代码?是否有可以删除的日志或调试代码?
安全
所有的数据输入是否都进行了检查(检测正确的类型,长度,格式和范围)并且进行了编码?在哪里使用了第三方工具,返回的错误是否被捕获?输出的值是否进行了检查并且编码?无效的参数值是否能够处理?
文档
是否有注释,并且描述了代码的意图?所有的函数都有注释吗?对非常规行为和边界情况处理是否有描述?第三方库的使用和函数是否有文档?数据结构和计量单位是否进行了解释?是否有未完成的代码?如果是的话,是不是应该移除,或者用合适的标记进行标记比如‘TODO’?
转载请注明原文地址: https://ju.6miu.com/read-1203514.html