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

Harlaus

2018-09-26 11:10:10 +08:00

注释永远不嫌多
注释永远不嫌多
注释永远不嫌多

Harlaus

2018-09-26 11:10:35 +08:00

注释永远不嫌多

jacatch

2018-09-26 11:18:11 +08:00

其他语言我不好说，反正 java 里，如果在方法里面写注释，不单独拿出一行写，我绝对会 neng 死他

jlyybz

2018-09-26 11:21:36 +08:00

喜欢这样的人除了特别牛的大佬应该都不会觉得注释多

socradi

2018-09-26 11:25:40 +08:00

硬盘空间不足的时候可能会

DiamondY

2018-09-26 11:25:40 +08:00

注释写“太多”的话，看代码的时候翻白眼，鄙视是肯定有的，至于动不动手去打，就看心情了

qingfengxm

2018-09-26 11:27:03 +08:00

注释多少都不怕，怕的是注释和代码版本不同步，代码是新代码注释是旧代码的注释，注释就没什么卵用了

calpamomo

2018-09-26 11:35:27 +08:00

这个应该是 JSDoc 吧，不怕的

icySoda

2018-09-26 11:35:55 +08:00

写注释的三个层次:
1. 什么代码都不写注释
2. 什么代码都写注释
3. 只在关键处(难理解处 /易出错处 /易混淆处)写注释

同事也喜欢写很多注释, 还要求我也跟他一样写, 烦得要死
200 行的代码, 500 行的注释, 而且注释跟代码还不一样.
注释里参数是字符串类型, 代码里却是布尔类型.

Joyboo

2018-09-26 12:06:43 +08:00

多了会不会挨打我不知道，但少了肯定会挨打

chungzhao

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

适可而止

kiinlam

2018-09-26 12:19:16 +08:00

简单扼要就行，能生成文档更好，有小 demo 最佳

zhangZMZ

2018-09-26 12:23:06 +08:00

太多？什么是多？多少是多，多少是少？

libook

2018-09-26 12:26:11 +08:00

寻其根本，写注释是为了什么？

对于这个问题，我的答案是：能让大多数人轻松看懂我的代码，简而言之就是提高可读性。

而提高可读性不一定就要靠尽可能多地写注释，甚至不一定要靠注释，不管你用什么办法，只要达到了“能让大多数人轻松看懂我的代码”的目标就可以了。

注释越多就越能越轻易看懂吗？
不一定，像《三傻大闹宝莱坞》里主角用了一大串“定义”来描述“书”的时候，教授完全没听懂是什么。
但有的时候算法真的非常复杂，少一点注释就解释不清楚，这时候不妨吧代码拆一拆，分段由浅及深写注释，可能效果会更好一些，想象一下如何才能给一个对物理学完全不了解的小学生讲明白相对论。

laike9m

2018-09-26 12:26:17 +08:00

有比没有好。
但更好的做法或许是让变量名本身就体现出其含义，作用。

victorywangzhcn

2018-09-26 12:35:56 +08:00

此处应该 @syhily

ica10888

2018-09-26 13:55:47 +08:00

不会

wangccddaa

2018-09-26 14:11:03 +08:00

我记得有句话：真正好的代码是不需要注释的，如果你需要大量注释来解释你的代码，那说明你的代码还是不够好

taevas

2018-09-26 14:20:53 +08:00

@wangccddaa 说的比唱的好听，在座的都几十年开发？就算给个几十年，代码写出来不还是那 b 样嘛。加点注释很有必要

kx5d62Jn1J9MjoXP

2018-09-26 14:21:56 +08:00

不会
但是会因为进度太慢挨打