企业🤖AI Agent构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
代码审查是确保系统质量和用户体验的正式流程中的基石。这涉及到召开一个由标记编写者、审查者和其他相关人员参加的会议,在会上提交有关材料,产生后续的代码修改要求。简单地说,我们鼓励进行代码审查,磨刀不误砍柴工嘛。 **为啥俺要参加代码审查涅?** 代码审查是用于降低项目风险的战略性时间投资。 经常地,接口开发者被要求根据线框图或视觉构图编写标记。不过,有可能设计的屏幕不能轻易转换为标记,或者转换后质量有损失。代码审查为在页面投入生产之前发现并解决这些风险提供了一个机会。 **代码审查能够提升跨项目的整体知识水平** 既然代码审查涉及到项目内外的成员,这有利于在整个团队中分享技术和最佳实践。 **代码审查能在bug从一些模板繁衍到多个页面之前就封杀它们** 理想情况下,代码审查是在开发过程的早期进行的,早于页面开始全面投入生产。当模板被团队审查并在多个校验工具和浏览器运行,潜在的bug就会冒出来。这是修复bug的理想时机。 **代码审查给不熟悉项目的外部成员提供了发现代码中问题的机会** 项目外部的审查者比在代码上工作了更长时间的标记编写者更容易发现问题。 **哪些人应该参加代码审查?** 归根到底,项目的前端工程主管要负责确保代码审查遵循合适的流程。 理想情况下,一位部门主管应该作为代码审查的主持人,除非部门主管自己正好是被审查代码的接口开发者。在这种情况下,由一位项目经理进行主持。 审查小组应该包括至少两位来自接口技术团队精通开发和最佳实践的资深成员。 **代码审查中有哪些要求?** 在进行代码审查之前,需要审查的模板必须整体完成开发、经过校验、并针对项目需要用到的浏览器和平台进行了测试。 部门主管 和/或 接口开发者必须在代码审查前至少48小时 分发以下材料: * 所有页面代码,相关的服务器端引用,CSS 和Javascript。这些必须有完整注释,左侧列出行号,在每个打印页的页脚标明文件/页面名称。 * 每个模板的截屏 * 如果适用,标明模板对应的URL * 项目支持的浏览器和平台的清单 * 已知问题和关注领域的清单 很典型的情况是,直到代码审查进行之前,代码还在不断地修改。不幸的是,这样就没有足够的时间来校验和测试了。如果这种情况发生了,最好是重新安排代码审查的时间以确保其效果。 另外,部门主管 和/或 接口开发者应该预定一间会议室和电话会议号码并提供给所有参与者,因为有可能某些项目组或审查组成员不在现场。用一个小时来审查两三个模板应该足够了;不过,需要的时间也随模板的大小和复杂度而不同。 在代码审查过程中,一位部门主管 和/或 接口开发者应该主持会议,而部门主管或项目经理做记录并分配行动事项。审查者应该在事前审阅过代码并准备好提问或提供反馈意见。 记录和行动事项(包括负责人)应该在代码审查后分发给所有参与者。如果代码审查产生了本质性的变更,或没有完成对所有代码的审查,就有必要安排第二次代码审查。不过,这必须在项目组内讨论以确定其可行性。