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

[fundebug]

[chengkai1853]

@easylee github 上从来没见过你说的这种 2:1 项目，还是大佬们的项目太渣了？ 求给个 2:1 项目做模板看看！😝

[xifangczy]

略多了点，精简下语言 还行。

[tonychow]

如果遗留了旧实现的注释或者忘了更新就会被打

[jmk92]

让我想起来，过去一同事，工作提前做完做完了没事干，疯狂写注释。

[wolfie]

就喜欢这种注释多的。

调用没有注释的烂代码，不知道要浪费多少时间。

[whnzy]

每行 79 个字符(逃

[maemolee]

不嫌麻烦的话，最好能把注释写的淋漓尽致的，别人看起来方便。

[pynix]

很多代码可以自注释就不用写了。。

[jones]

翻翻开源项目的源代码，spring, hibernate 这些,注释通常都比代码行数多，尤其是 public 的 API,

[easylee]

@chengkai1853

非常抱歉，是我的错误，没有指明这个比例的出处。
1/2 的比例是我在很久以前的代码规范的书本上看到的，那本册子我已经找不到了。

不过内容依稀记得，你所指的 git 上面的来源项目注释不多，可能大多因为有手册或者文档，并未做成注释。

[pkoukk]

不会挨打，但是你这样写的问题是，如果你的函数修改了，还有一大片文档要改，如果改函数不改文档，会被打死。还不如不写

[konakona]

你这个还只是变量注释。变量有注释很重要哦！

[konakona]

这样写严格来说是不规范的，IDE 不友好。
比如说我再其他地方或者这个文件的下面，按 ctrl 剑鼠标放在变量上面，并不能出现完整的注释内容哦。
请按照规范写。

[init]

讲真 我觉得真的是挺好的

[wobuhuicode]

JSer。 做了一段时间 OC 之后，注释少了，但是函数名长了

[dychenyi]

doxgen 生成一份详细开发说明书就是这么写的。 好多开源类的文档就是这么来的

[YzSama]

你排下版， 比如 注释文字对齐

[ashe]

让各位见笑了。这幅图的出处是我写的代码。
我不但有写注释的习惯，还有写文档的怪癖。
除了这个注释，我还配了一个上万字的文档..........
图略大。http://alonesuperman.com/statics/imgs/doc.png

[xiaoyang7545]

我觉得没问题，主要注释没有干扰到代码的阅读。

[jasonyang9]

注释和代码对不上，一定以及肯定会被打死