注释写得太多了会挨打吗？

2018-09-25 17:26:16 +08:00
 fundebug

16138 次点击
所在节点    程序员
145 条回复
zhangyichent
2018-09-25 18:16:17 +08:00
整整齐齐的没人不喜欢，怕的是乱七八糟不知所谓的注释。。。
endlessing
2018-09-25 18:26:07 +08:00
注释不嫌多，怕的是啰嗦表述不清的
zwwhdls
2018-09-25 18:28:05 +08:00
@yulitian888 写了注释，跟代码不一样才会被打呢
param
2018-09-25 18:32:24 +08:00
那就要问问 @returns 同学了
sampeng
2018-09-25 18:32:37 +08:00
这么多参数。提一个 obj 封装一下可好…
DOLLOR
2018-09-25 18:39:39 +08:00
注释跟代码不一致，误导读者的，才会被打。
zjp
2018-09-25 18:43:04 +08:00
mockio 推崇注释即文档，异常信息还带正确示范
anyele
2018-09-25 18:48:48 +08:00
挺好的，
moresteam
2018-09-25 18:56:26 +08:00
0 注释的路过
hheedat
2018-09-25 18:58:41 +08:00
我觉得还行
zwh2698
2018-09-25 19:06:07 +08:00
有枪🔫
firenine
2018-09-25 19:06:16 +08:00
这就体现 ts 的好处了，不用写这种注释
way2create
2018-09-25 19:08:32 +08:00
想起了上次那个画注释的帖子
cjpjxjx
2018-09-25 19:10:46 +08:00
这是前人栽树后人乘凉，比前人挖坑后人骂娘好多了
tangweihua163
2018-09-25 19:19:27 +08:00
参数这么多…就不是注释的问题了…
kerr92
2018-09-25 19:29:35 +08:00
像 20 楼说的，string/boolean/number 一般首字母小写，optional 的属性一般用中括号括起来。
fademeter
2018-09-25 19:31:03 +08:00
至少不会枪毙。
zcjfesky
2018-09-25 19:32:35 +08:00
当你接盘别人的项目的时候就知道这种耐心注释的选手简直就是天使…
zhzer
2018-09-25 19:32:54 +08:00
实在看不下去，可以让 ide 隐藏注释嘛
flight2006
2018-09-25 20:36:04 +08:00
注释是好习惯，这个注释明显啰嗦了，‘一般 xxx ’后面的都可以省略，说了等于白说

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

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

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

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

© 2021 V2EX