乌鲁木齐计算机培训代码审查清单怎么做?
苏州前端开发工程师学习:代码审查是一个很好的实践,可以帮助团队里的人员了解其他程序员在做什么,可以分享项目的上下文,可以分享技术上的一些小魔法,可以发现很多潜在的代码缺陷,可以提高代码质量,还可以有很多很多好处……
苏州前端开发工程师学习:代码审查清单怎么做?
然而,在实际的实现过程中,在许多情况下,它并不像预期的那样好,代码评审所暴露的问题本质上是如何权衡通信的成本和效益。在我们关于高效代码审查的博文中,我们建议使用一个检查清单。在代码评审中,清单是一个非常好的工具--它们确保评审可以在您的团队中持续进行。它们也是确保找到和解决共同问题的一种方便方法。
代码审查清单
一、常规项:
代码能够工作么?有没有实现预期的功能,逻辑是否正确等。所有的代码都很容易理解吗?编程代码符合你按照它的规格?包括但不局限于大括号的位置,变量名和函数名,行的长度,缩进,格式和注释。是否有多余或重复的代码?代码是否尽可能模块化?是否存在可替换的全局变量?是否有被注释掉的代码?回路是否设定了长度和正确的终止条件?是否有可以被库函数替换的代码?有没有可以删除的日志或调试代码?
二、安全:
所有的数据输入是否都进行了检查(检测正确的类型,长度,格式和范围)并且进行了编码??在哪里使用了第三方依赖或服务,返回的错误是否被捕获?输出值是否经过检查和编码?可以处理无效的参数值吗?
三、文档
文档是否有注释,并且描述了代码的意图?所有的函数都有注释吗?是否有非常规行为和边界处理的描述?是否有使用第三方库和函数的文档?是否解释了数据结构和测量单位?是否有未完成的代码?如果是的话,是不是应该移除,或者用合适的标记进行标记比如‘TODO’?
四、测试
测试代码是否可以测试?例如,不要添加太多或隐藏的依赖项,不能初始化对象,测试框架可以使用方法等等。是否存在测试,它们是否可以被理解?比如,至少达到你满意的代码覆盖(code coverage)。单元测试是否的代码是否能完成其预期的功能,真正的考验?是否检查了数组的越界错误?是否有可以被已经存在的API所替代的测试代码?
以上就是关于乌鲁木齐计算机培训的小知识,想了解更新更详细的内容吗,还不赶快拿起电话来电咨询,您也可以登录乌鲁木齐计算机培训的官方网站咨询访问。