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

2024-04-25 15:08

本文主要是介绍谷歌开源代码评审规范,代码好不好一目了然,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

来自:开源最前线(ID:OpenSourceTop)

谷歌很早之前就已经建立了一套通用的工程实战指南,它几乎囊括了所有编程语言与各种类型的项目。 这些文件代表了谷歌各种最佳实践的集合。近日 ,谷歌将这一套代码评审(Code Review)规范开源了出来。

640?wx_fmt=jpeg

目前,这份代码评审规范实际包含两套独立的文件:

代码评审者的指南
  • 代码评审标准

  • 代码评审希望达到什么

  • 在代码评审中导航修改列表

  • 代码评审的速度

  • 如何写审查的评论

  • 处理代码评审的回退

CL作者指南
  • 写一个好的修改列表描述

  • 构建一些小的修改列表

  • 如何处理代码评审者的评论

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

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

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

那么 ,代码审查者指南都在审查什么呢? 代码审查应该查看:
  • 设计:代码是否经过精心设计并适合你的系统?

  • 功能:代码的行为是否与作者的意图相同?代码的行为方式对用户有好处吗?

  • 复杂性:代码可以变得更简单吗?以后其他开发人员阅读此代码时是否能够轻松理解并使用

  • 测试:代码是否具有正确且设计良好的自动化测试?

  • 命名:开发人员是否为变量,类,方法等设置了易于理解的命名?

  • 注释:评代码注释是否清晰并且有用?

  • 风格:代码是否遵循标准的编写风格?

  • 文档:开发人员是否也更新了相关文档?

整个代码评审指南分为了很多模块,我们也没办法全部介绍一遍。感兴趣的伙伴们可以自行详细查阅

640?wx_fmt=png

目前,eng-practices已经在GitHub上获得 5560 个Star, 461 个Fork(GitHub地址: https://github.com/google/eng-practices/blob/master/review/index.md )

640?wx_fmt=jpeg

这篇关于谷歌开源代码评审规范,代码好不好一目了然的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/935024

相关文章

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

poj 1258 Agri-Net(最小生成树模板代码)

感觉用这题来当模板更适合。 题意就是给你邻接矩阵求最小生成树啦。~ prim代码:效率很高。172k...0ms。 #include<stdio.h>#include<algorithm>using namespace std;const int MaxN = 101;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int n

MySQL高性能优化规范

前言:      笔者最近上班途中突然想丰富下自己的数据库优化技能。于是在查阅了多篇文章后,总结出了这篇! 数据库命令规范 所有数据库对象名称必须使用小写字母并用下划线分割 所有数据库对象名称禁止使用mysql保留关键字(如果表名中包含关键字查询时,需要将其用单引号括起来) 数据库对象的命名要能做到见名识意,并且最后不要超过32个字符 临时库表必须以tmp_为前缀并以日期为后缀,备份

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能

SWAP作物生长模型安装教程、数据制备、敏感性分析、气候变化影响、R模型敏感性分析与贝叶斯优化、Fortran源代码分析、气候数据降尺度与变化影响分析

查看原文>>>全流程SWAP农业模型数据制备、敏感性分析及气候变化影响实践技术应用 SWAP模型是由荷兰瓦赫宁根大学开发的先进农作物模型,它综合考虑了土壤-水分-大气以及植被间的相互作用;是一种描述作物生长过程的一种机理性作物生长模型。它不但运用Richard方程,使其能够精确的模拟土壤中水分的运动,而且耦合了WOFOST作物模型使作物的生长描述更为科学。 本文让更多的科研人员和农业工作者

代码随想录冲冲冲 Day39 动态规划Part7

198. 打家劫舍 dp数组的意义是在第i位的时候偷的最大钱数是多少 如果nums的size为0 总价值当然就是0 如果nums的size为1 总价值是nums[0] 遍历顺序就是从小到大遍历 之后是递推公式 对于dp[i]的最大价值来说有两种可能 1.偷第i个 那么最大价值就是dp[i-2]+nums[i] 2.不偷第i个 那么价值就是dp[i-1] 之后取这两个的最大值就是d

pip-tools:打造可重复、可控的 Python 开发环境,解决依赖关系,让代码更稳定

在 Python 开发中,管理依赖关系是一项繁琐且容易出错的任务。手动更新依赖版本、处理冲突、确保一致性等等,都可能让开发者感到头疼。而 pip-tools 为开发者提供了一套稳定可靠的解决方案。 什么是 pip-tools? pip-tools 是一组命令行工具,旨在简化 Python 依赖关系的管理,确保项目环境的稳定性和可重复性。它主要包含两个核心工具:pip-compile 和 pip

D4代码AC集

贪心问题解决的步骤: (局部贪心能导致全局贪心)    1.确定贪心策略    2.验证贪心策略是否正确 排队接水 #include<bits/stdc++.h>using namespace std;int main(){int w,n,a[32000];cin>>w>>n;for(int i=1;i<=n;i++){cin>>a[i];}sort(a+1,a+n+1);int i=1

html css jquery选项卡 代码练习小项目

在学习 html 和 css jquery 结合使用的时候 做好是能尝试做一些简单的小功能,来提高自己的 逻辑能力,熟悉代码的编写语法 下面分享一段代码 使用html css jquery选项卡 代码练习 <div class="box"><dl class="tab"><dd class="active">手机</dd><dd>家电</dd><dd>服装</dd><dd>数码</dd><dd

生信代码入门:从零开始掌握生物信息学编程技能

少走弯路,高效分析;了解生信云,访问 【生信圆桌x生信专用云服务器】 : www.tebteb.cc 介绍 生物信息学是一个高度跨学科的领域,结合了生物学、计算机科学和统计学。随着高通量测序技术的发展,海量的生物数据需要通过编程来进行处理和分析。因此,掌握生信编程技能,成为每一个生物信息学研究者的必备能力。 生信代码入门,旨在帮助初学者从零开始学习生物信息学中的编程基础。通过学习常用