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

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

16147 次点击
所在节点    程序员
145 条回复
fyibmsd
2018-09-25 23:26:30 +08:00
你已经是个死人了
SoulGem
2018-09-25 23:39:20 +08:00
有点多说实话,这种 option 的注释写成文档会好一点。
scys
2018-09-25 23:54:07 +08:00
不要对一个参数写三行注释就行。
一页纸有 80%都是注释的代码,我看不下去。
northernlights
2018-09-26 00:04:36 +08:00
这是在写代码还是在写注释呢?垃圾代码写的注释再多也是垃圾代码,好代码不写注释也能让人一眼明白作者的思路。
looseChen
2018-09-26 00:44:01 +08:00
@northernlights 你能够一眼分辨出别人拉出来的屎? 抱歉 话有点糙
kslr
2018-09-26 00:55:02 +08:00
我只会写思路和需要注意的部分
RockShake
2018-09-26 08:21:54 +08:00
注释可以直接生成文档的,你这样省了写文档的工作,不是挺好的么,Java 代码大部分文档不都这样生成的么,一堆人连编程规范都没读过吧。
Howlaind
2018-09-26 08:45:04 +08:00
干脆搞文学式编程得了
bk201
2018-09-26 08:47:24 +08:00
维护起来相当麻烦,注释不应该面面俱到,应该关注重点.
Lawlieti
2018-09-26 09:14:09 +08:00
出来挨打
MaxTan
2018-09-26 09:30:11 +08:00
文档注释写再多都不怕。
a = 1; //给变量 a 赋值 这种直接打死
allgy
2018-09-26 09:31:44 +08:00
代码不够注释凑
aaronysj
2018-09-26 09:32:24 +08:00
参数是不是有点多
wqzjk393
2018-09-26 09:36:25 +08:00
flask 源码了解下。。满屏幕的注释
psklf
2018-09-26 09:39:00 +08:00
我推荐多写注释,越详细越好。
zhaogaz
2018-09-26 09:44:41 +08:00
最好写成类似 javadoc 的那种,能直接生成文档。

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

能做到以上 2 条的,基本是很优秀了。
kingwl
2018-09-26 09:46:38 +08:00
gesse
2018-09-26 09:50:36 +08:00
下注释的习惯是好的, 不过这个代码能力有待商榷
TomatoYuyuko
2018-09-26 09:50:44 +08:00
同步 xhr 要被封杀么,哪里的消息
fundebug
2018-09-26 09:57:03 +08:00

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

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

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

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

© 2021 V2EX