谷歌开源的代码评审规范,值得借鉴!
Java技术栈
共 2713字,需浏览 6分钟
·
2020-08-19 19:44
Java技术栈
www.javastack.cn
关注阅读更多优质文章
本文经机器之心(微信公众号:almosthuman2014)授权转载,禁止二次转载
项目作者:Max Kanat-Alexander 机器之心编译
谷歌以前建立了一套通用的工程实战指南,它差不多囊括了所有编程语言与各种类型的项目。今天,谷歌将这一套代码评审(Code Review)规范开源了出来,它代表了谷歌最佳实战经验的集合。
项目地址:https://github.com/google/eng-practices
代码评审标准
代码评审希望达到什么
在代码评审中导航修改列表
代码评审的速度
如何写审查的评论
处理代码评审的回退
写一个好的修改列表描述
构建一些小的修改列表
如何处理代码评审者的评论
设计:代码是不是经过精心的设计,并适合我们的系统?
功能性:代码的行为是否和作者的意图保持一致?代码的行为方式对用户是否正常?
复杂度:代码能更简单一些吗?在未来,其它开发者能更容易地理解并使用这些代码吗?
测试:代码是不是正确的,是不是通过了精心设计的自动测试?
命名:开发者是不是选择易于理解的名称给变量、类和方法进行命名?
评论:代码评论是不是足够清晰并有用?
风格:代码是不是采用了标准的编写风格?
文档:开发者是不是更新了相关的文档?
谷歌风格指南:http://google.github.io/styleguide/
点击「阅读原文」获取面试题大全~
评论