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

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

16136 次点击
所在节点    程序员
145 条回复
whypool
2018-09-25 17:33:54 +08:00
会,把注释当文档了
pain400
2018-09-25 17:34:17 +08:00
挺好的
orange1818
2018-09-25 17:36:10 +08:00
我已经备好手枪了
easylee
2018-09-25 17:37:56 +08:00
一份经久不衰的代码,注释量与代码量的比应该至少为 2:1。
fundebug
2018-09-25 17:39:01 +08:00
@orange1818 《刑法》第一百二十八条第一款的罪名为非法持有、私藏枪支、弹药罪。该款规定:违反枪支管理规定,非法持有、私藏枪支、弹药的,处三年以下有期徒刑、拘役或者管制;情节严重的,处三年以上七年以下有期徒刑。
smilepig
2018-09-25 17:39:05 +08:00
详细点是蛮好的。。。
wupher
2018-09-25 17:40:04 +08:00
别的都还好,console.warn 我笑了
Mariano
2018-09-25 17:40:11 +08:00
随便看了一眼,密密麻麻的字看的我头疼
yulitian888
2018-09-25 17:41:54 +08:00
不写注释才会被打呢
比如下面这样的:

/*

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



*/
ranoff
2018-09-25 17:45:49 +08:00
个人觉得的有点多
zhangjiabin1010
2018-09-25 17:46:40 +08:00
喜闻乐见啊,多写点注释,方便你我他
yangxiongguo
2018-09-25 17:48:04 +08:00
导出一下就是文档了啊
kios
2018-09-25 17:48:15 +08:00
写多了我不知道,写少了可能会被同事强杀
keinx
2018-09-25 17:48:47 +08:00
有个同事写的注释特别有意思,注释里面带了很多段子,有时候找 BUG 找的心烦,看到他的诡异注释还是挺不错的。
depress
2018-09-25 17:59:10 +08:00
我要是接手一个项目注释这么详细,我会请那个人吃顿饭,而且这个注释好在是在代码块外,如果是代码中,注释比代码还多,影响阅读代码那体验就很糟了。
mztql
2018-09-25 18:03:56 +08:00
规规整整的多好啊
janxin
2018-09-25 18:05:31 +08:00
没有 fuck,表明这段注释和代码是一个人写的 XD
HuHui
2018-09-25 18:08:04 +08:00
工作严重不饱和
SamsonWang
2018-09-25 18:08:12 +08:00
注释详细点挺好的
maichael
2018-09-25 18:10:26 +08:00
jsdoc 的话,选填属性应该这么写

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

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

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

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

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

© 2021 V2EX