加入收藏 | 设为首页 | 会员中心 | 我要投稿 通化站长网 (https://www.0435zz.com/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 站长资讯 > 传媒 > 正文

谷歌更新开源代码评审规范,代码好不好一目了然

发布时间:2021-03-27 11:37:32 所属栏目:传媒 来源:互联网
导读:者指南 写一个好的修改列表描述 构建一些小的修改列表 如何处理代码评审者的评论 其中一些文档中使用了Google的内部术语,Google也给出了详细的解释: CL:表示变更列表(changelist),意思是已经提交到版本控制或正在进行代码检查的一个独立的更改。其他组织

者指南

  • 写一个好的修改列表描述
  • 构建一些小的修改列表
  • 如何处理代码评审者的评论

其中一些文档中使用了Google的内部术语,Google也给出了详细的解释:

CL:表示“变更列表(changelist)”,意思是已经提交到版本控制或正在进行代码检查的一个独立的更改。其他组织通常称为“改变”或“补丁”。

LGTM:意思是“在我看来不错(Looks Good to Me)”,这是代码审阅者在批准 CL 时说的。

那么 ,代码审查者指南都在审查什么呢?代码审查应该查看:

  • 设计:代码是否经过精心设计并适合你的系统?
  • 功能:代码的行为是否与作者的意图相同?代码的行为方式对用户有好处吗?
  • 复杂性:代码可以变得更简单吗?以后其他开发人员阅读此代码时是否能够轻松理解并使用
  • 测试:代码是否具有正确且设计良好的自动化测试?
  • 命名:开发人员是否为变量,类,方法等设置了易于理解的命名?
  • 注释:评代码注释是否清晰并且有用?
  • 风格:代码是否遵循标准的编写风格?
  • 文档:开发人员是否也更新了相关文档?

整个代码评审指南分为了很多模块,我们也没办法全部介绍一遍。感兴趣的伙伴们可以自行详细查阅这份代码评审规范实际包含两套独立的文件:

代码评审者的指南

  • 代码评审标准
  • 代码评审希望达到什么
  • 在代码评审中导航修改列表
  • 代码评审的速度
  • 如何写审查的评论
  • 处理代码评审的回退

(编辑:通化站长网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    热点阅读