谷歌最佳实践 - 如何写代码审核评论

来源

如何写代码审核评论

概述

  • 友善一些
  • 清楚的阐述你的理由
  • 要在清楚地给出方向和指出问题后让开发者自己决定之间做好平衡
  • 鼓励开发者简化代码或者添加说明,而不是解释代码为什么这么复杂

礼貌

通常当你在审核别人的代码时,友善、尊重、提供清晰、有效的意见对于开发者是非常重要的。做到这个的方法是在评论中只针对代码,而不是开发者。你不一定需要一直按照推荐实践来操作,但是当你说一些负面的或者有争议的意见时一定要按照规范来。例如:
错误:“为什么在这种明显不需要并发的场景使用多线程呢?”
正确:“在这里使用并发只是增加了系统的复杂度我却没有发现任何实际的性能提升。因为没有性能提升,在这里最好使用单线程而不是多线程。”

解释原因

你发现刚才“正确”的例子中,能够帮助开发者理解为什么你要写下那些评论,有时候你要对你的目的做多一些解释,比如你遵循的最佳实践,或者你对于提升代码质量的一些建议

提供指导

通常修复变更提交是开发者的责任而不是审核者。作为审核者你不应该进行解决方案的详细设计或者帮助开发者编码。
但这并不意味着审核者不应提供任何帮助,尽管你要合理的掌握指出问题和直接提供解决方案之间的平衡。单单指出问题并且让开发者自己做出决定一般能够帮助其成长,审核行为也会更加简单。通常也会产生好的结果,因为开发者比审核者更理解代码和需求。
然而有时候直接的说明、建议、甚至代码会更有帮助。毕竟代码审核的目的就是使得提交的内容是最优的。第二目标才是提高开发者的技能,今后的审核能够更加快捷。

接受解释说明

当你要求开发者说明一块你无法理解的代码时,通常最终会要求开发者将代码重写得更加清晰。偶尔情况下,在代码中添加注释也是一个很好的回复,只要不是解释一块过于复杂的代码。
说明只写在代码审核工具中对于今后阅读代码的人并不是很有帮助。这在某些情况下才可以接受,例如你正在审核一个比较不熟悉的功能,开发者尝试给你解释一些其他大部分审核者都已经了解的内容。

下一篇:如何处理代码审核中的负面反馈

原文地址:https://www.cnblogs.com/pluto4596/p/11583798.html

时间: 2024-10-10 00:58:29

谷歌最佳实践 - 如何写代码审核评论的相关文章

最佳实践之 Android代码规范

命名规范 包命名规范 采用反域名命名规则,包名全部小写,连续的单词只是简单地连接起来,不使用下划线,一级包名为com,二级包名为xxx(可以是公司域名或者个人命名),三级包名根据应用进行命名,四级包名为模块名或层级名.如: com.isa.crm.activity | com.isa.crm.adapter JAVA类命名规范 采用大驼峰式命名法,尽量避免缩写,除非该缩写是众所周知的,比如HTML,URL,如果类名称包含单词缩写,则单词缩写的每个字母均应大写.如: Product | Produ

jquery编程的标准写法和最佳实践(jquery代码规范)

jQuery的加载 1.我们经常用CDN来加载网页,我之前的文章中也多次提及,点击查看使用CDN的好处, <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script> <script>window.jQuery || document.write('<script src=&q

用 Vim 写 Python 的最佳实践

先来晒个图: 对于一些 Python 的小项目,使用 vim 是一个不错的选择.本文内容整理自我在知乎的回答 用用 Vim 写 Python 的最佳实践是什么?,下面的内容是对知乎旧有回答的一个补充,尤其有一些主要针对 vim8. 如果想要更多内容,可以查看知乎对于该问题的一些回答. 语法检查 如果用 vim8, 那么可以用异步检测的 w0rp/ale 代替 syntastic 了,再也不用羡慕 flycheck, 也不用因为语法检查而卡顿了. 关于 ale 这部分的个性化配置,其实有点 "吹毛

(Android第一行代码实验一)活动的最佳实践

活动的最佳实践    1.知晓当前是在哪一个活动         这个技巧将教会你,如何根据程序当前的界面就能判断出这是哪一个活动.  首先需要新建一个 BaseActivity 继承自 Activity,然后在 BaseActivity中重写 onCreate()方法.         public class BaseActivity extends Activity {                @Override              protected void onCreat

编写超级可读代码的15个最佳实践

译自:http://net.tutsplus.com/tutorials/html-css-techniques/top-15-best-practices-for-writing-super-readable-code/ 译者:蒋宇捷        一月两次,我们重温Nettuts历史上读者最喜欢的文章. 代码可读性是一个计算机编程世界的普遍主题.它是我们作为开发者第一件学习的事情.这篇文章将阐述编写可读性代码十五个最重要的最佳实践. 1 – 注释和文档 集成开发环境IDE在过去的短短几年里走

iOS应用开发最佳实践:编写高质量的Objective-C代码

本文转载至 http://www.cocoachina.com/industry/20131129/7445.html 点标记语法 属性和幂等方法(多次调用和一次调用返回的结果相同)使用点标记语法访问,其他的情况使用方括号标记语法. 良好的风格 : view.backgroundColor = [UIColor orangeColor]; [UIApplication sha “” 阅读器 本文由“海水的味道"编译 点标记语法 属性和幂等方法(多次调用和一次调用返回的结果相同)使用点标记语法访问

最佳实践扩展Windows窗体DataGridView控件 .net 4.5 附示例代码

Windows窗体DataGridView控件的性能调优.net 4.5 在处理大量数据时, DataGridView 控制可以消耗大量的内存开销,除非你仔细地使用它. 在客户有限的内存,你可以避免一些这方面的开销,避免内存成本高的特性. 你也可以管理的部分或全部数据维护和检索任务自己使用虚拟模式为了定制的内存使用情况. 在这一节中 最佳实践扩展Windows窗体DataGridView控件 描述如何使用 DataGridView 控制,避免了不必要的内存使用和在处理大量数据时的性能损失. 虚拟

从零开始--系统深入学习android(实践-让我们开始写代码-Android框架学习-7.通知)

通知 一个通知是一条消息他是显示于你应用程序之外的一个界面中.当你告诉系统要发布一个通知时,它首先作为一个icon出现在通知区域.为了看见通知的细节,用户可以点击通知区域展开一个新的界面.下面让我们来看一下图7-1和图7-2: 图7-1 通知出现在通知区域 图7-2 通知展开后的效果(drawer) 注意:除非特别注明外,本章指的都是NotificationCompat.Builder,它在v4 Support Library中有,正式添加于API Level 15.但有了v4 Support

后台开发:核心技术与应用实践(边写代码边读书才是最好的学习方式)

写下这些文字的时候是我在腾讯工作的第五个年头,这五年让我对效率有了更深刻的认识.还是一个学生的时候,和大家一样,我也曾一字不落地读过<UNIX环境高级编程>,<UNIX环境网络编程>一二三卷,<TCP/IP详解>一二三卷,<C++ Primer>等书籍,这些都是非常经典的开发书籍.它们的共同特点是大而全,不漏掉任何一个知识点,并且每个知识点都讲得非常详细.但在实际的开发工作中,可能用到的知识点只有20%,其他的80%则很少用到.这也是我写这本书的初衷:用最短