如何看待 code review 中同事给出的建议全部都是注释上的

2018-09-12 01:37:35 +08:00
 Godaigo

新入职的湾区码农,code review 时候同事经常给出建议关于注释,比如句末少了句号,感觉他们的关注点完全不在代码本身,好像通过测试就 OK,代码审查全部靠读注释完成。有人也遇到类似的事情么?严格注释真的十分重要么?

4840 次点击
所在节点    程序员
32 条回复
gaohongyuan
2018-09-12 09:14:45 +08:00
同湾区,上周就被 manager 给了一堆注释没加句号的 comment
bk201
2018-09-12 09:17:31 +08:00
规则越苛刻,将来出问题的可能性越小
Godaigo
2018-09-12 11:08:02 +08:00
@Vindroid 是的 一来一去一天就过了。。。。
Godaigo
2018-09-12 11:13:14 +08:00
@gaohongyuan 看来老美还是很重视这种细节上的规范
LxExExl
2018-09-12 11:17:27 +08:00
我刚入职的时候也有这种困扰 连变量名用名词不用动词这种问题都要打回来重写

后来觉得那个同事还是很好 花时间花精力指出这些问题

而且习惯之后自己的代码看上去确实比之前质量好多了
Joyboo
2018-09-12 11:18:23 +08:00
@bk201 同意
jswh
2018-09-12 11:18:58 +08:00
注释是代码的一部分鸭
jswh
2018-09-12 11:19:25 +08:00
@jswh 好的代码是自注释的
TankyWoo
2018-09-12 11:28:32 +08:00
注释也能看出写代码是否严谨
Godaigo
2018-09-13 22:38:34 +08:00
@LxExExl 感觉我这个 reviewer 比较奇葩,指出问题不给修改意见,这是为何?有遇到过类似的事情么?
Godaigo
2018-09-13 22:39:37 +08:00
@TankyWoo 嗯嗯 感觉以后还得注意,以前学校的 project 都是自己写了自己看,老师只关心能不能跑,现在写了主要是给别人看得,角度不同了。
FrankHB
2018-09-15 05:19:32 +08:00
文法问题是你自己的锅,接好。然后找你们老大要 convention/guideline 自己对着检查做到让人找不出这种你认为同等程度琐碎的问题。句末少了句号这种在成熟的流程中就不应该占用 review 时间。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/488381

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX