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

[fundebug]

[whypool]

会，把注释当文档了

[pain400]

挺好的

[orange1818]

我已经备好手枪了

[easylee]

一份经久不衰的代码，注释量与代码量的比应该至少为 2:1。

[fundebug]

@orange1818 《刑法》第一百二十八条第一款的罪名为非法持有、私藏枪支、弹药罪。该款规定：违反枪支管理规定，非法持有、私藏枪支、弹药的，处三年以下有期徒刑、拘役或者管制；情节严重的，处三年以上七年以下有期徒刑。

[smilepig]

详细点是蛮好的。。。

[wupher]

别的都还好，console.warn 我笑了

[Mariano]

随便看了一眼，密密麻麻的字看的我头疼

[yulitian888]

不写注释才会被打呢
比如下面这样的：

/*

+---------------+
| |
| 本数据库操作类 |
| |
+--+--+---------+
| ^
v |
|
+-----+---------+
| |
| 数据库 |
| |
| |
+---------------+



*/

[ranoff]

个人觉得的有点多

[zhangjiabin1010]

喜闻乐见啊，多写点注释，方便你我他

[yangxiongguo]

导出一下就是文档了啊

[kios]

写多了我不知道，写少了可能会被同事强杀

[keinx]

有个同事写的注释特别有意思，注释里面带了很多段子，有时候找 BUG 找的心烦，看到他的诡异注释还是挺不错的。

[depress]

我要是接手一个项目注释这么详细，我会请那个人吃顿饭，而且这个注释好在是在代码块外，如果是代码中，注释比代码还多，影响阅读代码那体验就很糟了。

[mztql]

规规整整的多好啊

[janxin]

没有 fuck，表明这段注释和代码是一个人写的 XD

[HuHui]

工作严重不饱和

[SamsonWang]

注释详细点挺好的

[maichael]

jsdoc 的话，选填属性应该这么写

```
@param {string} [somebody] - Somebody's name.
```

[zhangyichent]

整整齐齐的没人不喜欢，怕的是乱七八糟不知所谓的注释。。。

[endlessing]

注释不嫌多，怕的是啰嗦表述不清的

[zwwhdls]

@yulitian888 写了注释，跟代码不一样才会被打呢

[param]

那就要问问 @returns 同学了

[sampeng]

这么多参数。提一个 obj 封装一下可好…

[DOLLOR]

注释跟代码不一致，误导读者的，才会被打。

[zjp]

mockio 推崇注释即文档，异常信息还带正确示范

[anyele]

挺好的，

[moresteam]

0 注释的路过

[hheedat]

我觉得还行

[zwh2698]

有枪🔫

[firenine]

这就体现 ts 的好处了，不用写这种注释

[way2create]

想起了上次那个画注释的帖子

[cjpjxjx]

这是前人栽树后人乘凉，比前人挖坑后人骂娘好多了

[tangweihua163]

参数这么多…就不是注释的问题了…

[kerr92]

像 20 楼说的，string/boolean/number 一般首字母小写，optional 的属性一般用中括号括起来。

[fademeter]

至少不会枪毙。

[zcjfesky]

当你接盘别人的项目的时候就知道这种耐心注释的选手简直就是天使…

[zhzer]

实在看不下去，可以让 ide 隐藏注释嘛

[flight2006]

注释是好习惯，这个注释明显啰嗦了，‘一般 xxx ’后面的都可以省略，说了等于白说

[entimm]

把代码写成白话文不是更好吗

[Yuicon]

这么一看 java 虽然啰嗦点 但是可以少写很多 ‘注释’

[sonyxperia]

我觉得挺好

[lightening]

信息太多会让真正重要的信息无法找到

[wsxyeah]

命名很重要，窃以为见名知意要比写一大堆冗余的注释要好得多

[xuanbg]

挺好的，排版再对齐一下就更好了。

[oxoxoxox]

这种注释挺好的 标准做法 直接就能导出成文档了 应该鼓励
乱写注释才会被人打

[fundebug]

@lightening 注释应该言简意赅！

[framehouse]

有点啰嗦，不过看十行弱智注释也好过看一行莫名其妙的代码

[gbin]

@sampeng 参数 option 本身就是一个对象

[neilp]

太闲 了

[bfpiaoran]

我咋觉得遇到这种开发就该嫁了呢

[catror]

写给别人使用的接口就应该写这样的注释，然而，你会发现调用接口的人还是会来问你 :|

[PP]

可以直接加薪。

[lijun0926]

挺规范

[hellodigua]

学习了……

[hotsymbol]

看的想死

[imn1]

挨打是小事……

[nodin]

简洁明了的注释没人不喜欢，外行人也能看明白这代码用来做什么的注释肯定是好注释。

[jmc891205]

時間久了發現實現和註釋不一樣了:(

[fyibmsd]

你已经是个死人了

[SoulGem]

有点多说实话，这种 option 的注释写成文档会好一点。

[scys]

不要对一个参数写三行注释就行。
一页纸有 80%都是注释的代码，我看不下去。

[northernlights]

这是在写代码还是在写注释呢？垃圾代码写的注释再多也是垃圾代码，好代码不写注释也能让人一眼明白作者的思路。

[looseChen]

@northernlights 你能够一眼分辨出别人拉出来的屎？ 抱歉 话有点糙

[kslr]

我只会写思路和需要注意的部分

[RockShake]

注释可以直接生成文档的，你这样省了写文档的工作，不是挺好的么，Java 代码大部分文档不都这样生成的么，一堆人连编程规范都没读过吧。

[Howlaind]

干脆搞文学式编程得了

[bk201]

维护起来相当麻烦,注释不应该面面俱到,应该关注重点.

[Lawlieti]

出来挨打

[MaxTan]

文档注释写再多都不怕。
a = 1; //给变量 a 赋值 这种直接打死

[allgy]

代码不够注释凑

[aaronysj]

参数是不是有点多

[wqzjk393]

flask 源码了解下。。满屏幕的注释

[psklf]

我推荐多写注释，越详细越好。

[zhaogaz]

最好写成类似 javadoc 的那种，能直接生成文档。

其他的注释只保留极少部分 必要的就够了。

能做到以上 2 条的，基本是很优秀了。

[kingwl]

[gesse]

下注释的习惯是好的， 不过这个代码能力有待商榷

[TomatoYuyuko]

同步 xhr 要被封杀么，哪里的消息

[fundebug]

@wqzjk393 果然是这样哈哈： https://github.com/pallets/flask/blob/master/flask/app.py

[ben1024]

不推荐写注释，写注释是因为看代码不知道在做什么

[zsy979]

如果注释跟代码是一致的请他吃饭啊

[Linxing]

你敢不写试试？

[Edwards]

接受代码写得不好，但是不接受文档写的不好的，同理注释。

[NicholasYX]

一打眼就能看明白的没有必要写注释吧……

[xpresslink]

@fundebug
python 有一个专门生成文档的工具叫 sphinx，自己从代码中抽取注释生成结构化的 HTML 文档。
flask 的文档就是这么生成的。
好处是文档和代码是在一起的便于维护更新，每个人在代码里写自己的文档就好了。
最后只要生成一下就是最新的文档了，不用费力有专人去维护文档的一致性。

[q397064399]

@fundebug #80 Python 没有注释 就没法合作了，这种动态语言 是真的令人难受

[brondogk886]

这么全面的注释，不维护的话估计会被人打死

[xxl11231220]

求之不得。表示嫌弃不写少些注释的

[FifiLyu]

代码应该做到自解释，你这样如果精力不够时，很容易出现注释和代码不同步，最终更加误导人。

[junbaor]

看起来这是个稍微底层的方法，这注释写的，完美~

[northernlights]

@looseChen 我可没这本事，看来你经验丰富，你自己去吃吧。

[tiedan]

待过一家公司都不让写注释

[noNOno]

还是蛮好的

[ioth]

我会比较尊重这样的孩子。

[Mavious]

作为新手，最喜欢注释多多的代码了，每一行的功能都能靠注释看懂。
多多益善。

[ljspython]

注释永远不嫌多

[nomemo]

挺不错的，就是要持续维护

[AllenW]

这注释 厉害了

[sorra]

写错了才挨打