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

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

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

5002 次点击
所在节点    程序员
32 条回复
TtiGeR
2018-09-12 02:02:40 +08:00
在有些公司,严格注释真的十分重要。
hearfish
2018-09-12 02:03:18 +08:00
严格注释还是需要的,我也经常遇到被要求改注释的时候,有良好质量的注释有助于新人对代码的理解。不过代码本身也要过关啊,测试用例是不是足够多之类的应该也会在 code review 上提出来吧
findingpan
2018-09-12 02:04:46 +08:00
我是感觉每一行代码都看浪费时间 看看注释 知道这一部分的逻辑是什么 然后再看看一些 loop 等关键点就完了 但是我的同事就很认真 每次 variable name 都会认真讨论一下 感觉没什么不好
johnnie502
2018-09-12 02:05:54 +08:00
你们不用 Style Check, lint 之类的工具么,能解决大部分注释的格式问题。如果不是格式问题的话,那可能就是你的注释写的不够详细
vHypnos
2018-09-12 02:08:22 +08:00
那你们不错了。我这基本没有人 review。只要能编译就行。
Godaigo
2018-09-12 02:09:05 +08:00
@johnnie502 有的,只不过类似于句首首字母大写或者标点符号这样的是查不出的,可能也是我英文不够好吧 :)
Godaigo
2018-09-12 02:09:35 +08:00
@vHypnos 晚上不会做噩梦么 哈哈哈
Godaigo
2018-09-12 02:11:08 +08:00
@findingpan 嗯,可能我刚入职吧,我看代码时候就希望能看懂逻辑,看看变量名,看不懂才会看注释。。。还是太 naive 了
vHypnos
2018-09-12 02:11:14 +08:00
@Godaigo #7 是很难受啊。我一直在组内说,需要加 review 环节。但是没有人干。毕竟是小公司,大佬们认为软件能跑就好。
PythonAnswer
2018-09-12 02:14:23 +08:00
注释
unittest

都很重要
Godaigo
2018-09-12 02:14:30 +08:00
@hearfish 嗯嗯 只不过感觉有些时候对注释有点苛求(虽然 code base 里的注释也是五花八门)
shiyouming91
2018-09-12 02:26:13 +08:00
Performance oriented review...
Godaigo
2018-09-12 02:29:11 +08:00
@shiyouming91 啥意思捏?
hearfish
2018-09-12 02:29:57 +08:00
@Godaigo 习惯就好了,我理解我们公司 code base 基本就是靠注释啃下来的,有时候注释比代码段还长。。
yegle
2018-09-12 02:35:55 +08:00
跟 manager 聊聊,涉及歧视了
tvallday
2018-09-12 05:18:58 +08:00
这样简单啊。遇到一次提交就要要求 refactor 到他认为的最优设计的才惨。做一个 feature 下来劳心劳力。
Vindroid
2018-09-12 08:38:21 +08:00
@tvallday 我现在的项目就是如此啊,不过我觉得这样挺好,真的能和大神学到很多东西,就是来来回回拖的时间有些长
nooper
2018-09-12 08:52:49 +08:00
知不知道,老外事无巨细。所以你还是注意一下,不要让对方总挑你犯错误的理由
wowo243
2018-09-12 08:55:56 +08:00
@Godaigo 我猜是面相绩效 review
ghbai
2018-09-12 09:08:07 +08:00
是 code review 而不是 comment review
大部分 bug 就是注释(想要做的)和代码(实际做的)不一致导致的啊

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

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

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

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

© 2021 V2EX