2024年4月14日发(作者：)
如何进行 Code Review
Code Review是软件开发中必不可少的一环。通过代码审查，
我们可以确保代码质量、减小错误率、提高开发效率、传递技术
知识，以及为后期维护提供辅助。
那么，怎么进行有效的Code Review呢？
一. 代码的可阅读性
代码是为人写的，应该首先保证代码的可读性。对于初学者来
说，代码可读性的好坏很大程度上影响其学习效率。当然，对于
经验丰富的开发者，代码可读性也是极其重要的。因为一个人负
责写的代码不一定会被他人维护，如何让其他人更好地维护和修
改这段代码，就需要你在编写时思考如何增加代码可读性。
提供几个注意事项：
1. 命名规范
合理的命名紧扣逻辑，能让代码更清晰易懂。命名应该简洁明
了，可读性好，尽量避免缩写和单个字母的变量名。有时会面临
命名困惑，此时可参考别人的命名方法结合当前情况。
2. 函数
考虑单一职责原则，函数尽量简单而不失灵活性，接口设计简
洁清晰，如果接口过于复杂，建议重新考虑设计接口。
3. 注释
注释必须要有，但并不是越详细越好。注释要简单明了，方便
快速阅读，同时充分表达函数功能，设置中英文注释+markdown
格式更佳。
二. 测试+代码静态分析
开发者在编写代码时，往往会有个人偏好。有时候开发者会在
编写完代码后觉得极为优雅，有一种“曲高和寡”的感觉。但从实
施的角度来看，除了开发者本人，其他人改写该代码甚至读懂都
很困难。如何解决这个问题呢？
首先，测试！除了笔试、面试这些环节能考察测试知识外，在
实际工作中每一个人都有能力能写出优秀的测试。提供几点测试
建议：
1. 单元测试
较小的函数可以逐个测试，保证其正确性，测试代码同样需要
code review。
2. 集成测试
所有功能集成测试不可少，比如一些微服务，需要模拟对外接
口和对其他服务的调用来进行全面测试。
3. 总结测试数据
测试数据要有多样性，能够覆盖函数、逻辑分支、边界等各种
情况。
其次，静态代码分析从代码的静态结构、语法、数据流等角度
对程序进行分析，可以找出其中的潜在漏洞和缺陷，警告开发者
以尽快修正。这里推荐大家使用市场上的code review工具，例如
sonarqube等。
三. 审查过程
除了之前提到的代码风格和测试，还需要了解以下内容：
1. 代码是否能正常运行
整个代码库在编写完之后可以保证能够运行，如果有无法运行
的代码可以拒掉。如果是尝试全局搜索，是否会有死循环等错误。
2. 变量的合理使用
如果一个变量有了值，一定要考虑它是否存在，是否已经在代
码的其他地方被改变，是否已经被释放。
3. 函数的协调和沟通
团队代码评审最重要的是团队，合作精神和沟通，要写好代码，
必须先从面向高质量的团队角度思考。
四. 结语
Code Review是一个相互学习和共同提高技术水平的过程，开
发者应该认真对待，而老手开发者则有义务为新手提供指导和帮
助。优秀的Code Review遵循可读性、测试、静态代码分析、审
查过程四个大方向，因此要从代码质量、编码能力、团队合作、
等方面展开会议或评审讨论。通俗一点，为了大家都可以看得懂，
编写好代码，做好Code Review，让他人也都看得懂。
发布者：admin，转转请注明出处：http://www.yc00.com/web/1713048016a2172432.html
评论列表（0条）