如何编写代码评论

概要

  • 要和善和蔼
  • 说明解释你的理由
  • 给出明确的方向,指出问题,让开发人员来决定。
  • 鼓励开发人员简化代码或添加代码注释,而不是仅仅向您解释代码的复杂性。

礼貌

一般来说,礼貌和尊重是很重要的,同时评论也要对你正在审查代码的开发人员非常清晰和有帮助。确保你总是对代码进行评论,而绝不是对开发人员进行评论。你不必总是遵循这个惯例,但是当你说一些可能会令人心烦或有争议的话时,你绝对应该使用它。

反例:“为什么你在这里使用线程,而且显然没有从并发中获得任何好处?”

正例:“这里的并发模型增加了系统的复杂性,但我看不到任何实际的性能优势。因为没有性能上的好处,所以这段代码最好是单线程的,而不是使用多个线程。

解释为什么

关于上面的“好”示例,你会注意到一件事:它帮助开发人员理解你为什么要进行评论。你并不总是需要在评论中包含这些信息,但是有时候,对于你的意图、你所遵循的最佳实践,或者你的建议如何改进代码健康状况,给出更多的解释是合适的。

给予指导

一般来说,修复CL是开发人员的责任,而不是评审员的责任。你不需要为开发人员进行详细的解决方案设计或编写代码。

不过,这并不意味着评审员不应该给予帮助。一般来说,你应该在指出问题和提供直接指导之间取得适当的平衡。指出问题并让开发人员做出决定通常有助于开发人员学习,并使代码评审变得更容易。它还可以产生更好的解决方案,因为开发人员比评审员更接近代码。

然而,有时直接的指示、建议甚至编码更有帮助。代码评审的主要目标是获得尽可能好的CL。第二个目标是提高开发人员的技能,使他们需要的审查时间越来越少。

接受解释

如果你让开发人员解释一段你不理解的代码,通常会导致他们重写代码时更清晰。偶尔,在代码中添加注释也是一种适当的响应,只要它不仅仅是解释过于复杂的代码。

仅在代码评审工具中编写的解释对将来的代码读者没有帮助。它们只在少数情况下是可接受的,例如当你正在评审一个你不太熟悉的区域,并且开发人员解释一些代码的普通读者已经知道的内容时。

下一章:如何处理代码推回

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容

  • 安昕瑜,蔡新宇,孔庆振 翻译 2017年1月31日 弗格斯·亨德森 <fergus@google.com>(工作)...
    senju阅读 3,612评论 0 2
  • 注意:在考虑这些要点时,一定要考虑到Code Review标准 设计 在评审中最重要的是CL的整体设计。CL中不同...
    老猫_jerry阅读 624评论 0 1
  • 听了这么久的刘润5分钟商学院课程,学到了很多东西,今天的三个八理论也是说得极好,我们很多时候都不会合理的有意义的去...
    如意Fineyoga阅读 327评论 0 1
  • 本人男,文科生,平时的爱好也就看看书,写写东西,有时也喜欢一些日本电影和美剧,小文青一枚,大一一年时间自学口风琴和...
    季凌沐阅读 840评论 14 17
  • 今早六点多就出门了,要赶到学校开一个会。做完地铁到达做校车的地方还有步行需十分钟的距离,就在地铁站扫了个摩...
    泅海阅读 130评论 0 0