新入职的湾区码农，code review 时候同事经常给出建议关于注释，比如句末少了句号，感觉他们的关注点完全不在代码本身，好像通过测试就 OK，代码审查全部靠读注释完成。有人也遇到类似的事情么？严格注释真的十分重要么？
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
This topic created in 2978 days ago, the information mentioned may be changed or developed.
 |
TtiGeRSep 12, 2018 via iPhone
1
在有些公司，严格注释真的十分重要。
|
 |
hearfishSep 12, 2018
2
严格注释还是需要的，我也经常遇到被要求改注释的时候，有良好质量的注释有助于新人对代码的理解。不过代码本身也要过关啊，测试用例是不是足够多之类的应该也会在 code review 上提出来吧
|
 |
findingpanSep 12, 2018
3
我是感觉每一行代码都看浪费时间 看看注释 知道这一部分的逻辑是什么 然后再看看一些 loop 等关键点就完了 但是我的同事就很认真 每次 variable name 都会认真讨论一下 感觉没什么不好
|
 |
johnnie502Sep 12, 2018
4
你们不用 Style Check, lint 之类的工具么，能解决大部分注释的格式问题。如果不是格式问题的话，那可能就是你的注释写的不够详细
|
 |
vHypnosSep 12, 2018
5
那你们不错了。我这基本没有人 review。只要能编译就行。
|
 |
6
@johnnie502 有的，只不过类似于句首首字母大写或者标点符号这样的是查不出的，可能也是我英文不够好吧 :)
|
|
8
@findingpan 嗯，可能我刚入职吧，我看代码时候就希望能看懂逻辑，看看变量名，看不懂才会看注释。。。还是太 naive 了
|
 |
PythonAnswerSep 12, 2018
10
注释
unittest 都很重要 |
 |
shiyouming91Sep 12, 2018 via iPhone
12
Performance oriented review...
|
|
13
@shiyouming91 啥意思捏？
|
 |
yegleSep 12, 2018
15
跟 manager 聊聊，涉及歧视了
|
 |
tvalldaySep 12, 2018 via Android
16
这样简单啊。遇到一次提交就要要求 refactor 到他认为的最优设计的才惨。做一个 feature 下来劳心劳力。
|
 |
nooperSep 12, 2018 via iPad
18
知不知道，老外事无巨细。所以你还是注意一下，不要让对方总挑你犯错误的理由
|
 |
ghbaiSep 12, 2018
20
是 code review 而不是 comment review
大部分 bug 就是注释(想要做的)和代码(实际做的)不一致导致的啊 |
 |
gaohongyuanSep 12, 2018 via iPhone
21
同湾区，上周就被 manager 给了一堆注释没加句号的 comment
|
 |
bk201Sep 12, 2018
22
规则越苛刻,将来出问题的可能性越小
|
|
24
@gaohongyuan 看来老美还是很重视这种细节上的规范
|
 |
LxExExlSep 12, 2018 via iPhone
25
我刚入职的时候也有这种困扰 连变量名用名词不用动词这种问题都要打回来重写
后来觉得那个同事还是很好 花时间花精力指出这些问题 而且习惯之后自己的代码看上去确实比之前质量好多了 |
 |
jswhSep 12, 2018
27
注释是代码的一部分鸭
|
 |
TankyWooSep 12, 2018
29
注释也能看出写代码是否严谨
|
|
31
@TankyWoo 嗯嗯 感觉以后还得注意，以前学校的 project 都是自己写了自己看，老师只关心能不能跑，现在写了主要是给别人看得，角度不同了。
|
 |
FrankHBSep 15, 2018
32
文法问题是你自己的锅，接好。然后找你们老大要 convention/guideline 自己对着检查做到让人找不出这种你认为同等程度琐碎的问题。句末少了句号这种在成熟的流程中就不应该占用 review 时间。
|
Select Language