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

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 2265 天前的主题，其中的信息可能已经有所发展或是发生改变。

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

注释

Review

Code

代码

32 条回复 • 2018-09-15 05:19:32 +08:00

TtiGeR

2018-09-12 02:02:40 +08:00 via iPhone

在有些公司，严格注释真的十分重要。

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 via iPhone

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 via Android

这样简单啊。遇到一次提交就要要求 refactor 到他认为的最优设计的才惨。做一个 feature 下来劳心劳力。

Vindroid

2018-09-12 08:38:21 +08:00

@tvallday 我现在的项目就是如此啊，不过我觉得这样挺好，真的能和大神学到很多东西，就是来来回回拖的时间有些长

nooper

2018-09-12 08:52:49 +08:00 via iPad

知不知道，老外事无巨细。所以你还是注意一下，不要让对方总挑你犯错误的理由

wowo243

2018-09-12 08:55:56 +08:00 via Android

@Godaigo 我猜是面相绩效 review

ghbai

2018-09-12 09:08:07 +08:00

是 code review 而不是 comment review
大部分 bug 就是注释(想要做的)和代码(实际做的)不一致导致的啊

gaohongyuan

2018-09-12 09:14:45 +08:00 via iPhone

同湾区，上周就被 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 via iPhone

我刚入职的时候也有这种困扰连变量名用名词不用动词这种问题都要打回来重写

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

而且习惯之后自己的代码看上去确实比之前质量好多了

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 时间。