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

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

16147 次点击
所在节点    程序员
145 条回复
ben1024
2018-09-26 09:57:19 +08:00
不推荐写注释,写注释是因为看代码不知道在做什么
zsy979
2018-09-26 10:01:32 +08:00
如果注释跟代码是一致的请他吃饭啊
Linxing
2018-09-26 10:01:57 +08:00
你敢不写试试?
Edwards
2018-09-26 10:06:01 +08:00
接受代码写得不好,但是不接受文档写的不好的,同理注释。
NicholasYX
2018-09-26 10:11:46 +08:00
一打眼就能看明白的没有必要写注释吧……
xpresslink
2018-09-26 10:14:33 +08:00
@fundebug
python 有一个专门生成文档的工具叫 sphinx,自己从代码中抽取注释生成结构化的 HTML 文档。
flask 的文档就是这么生成的。
好处是文档和代码是在一起的便于维护更新,每个人在代码里写自己的文档就好了。
最后只要生成一下就是最新的文档了,不用费力有专人去维护文档的一致性。
q397064399
2018-09-26 10:18:49 +08:00
@fundebug #80 Python 没有注释 就没法合作了,这种动态语言 是真的令人难受
brondogk886
2018-09-26 10:18:59 +08:00
这么全面的注释,不维护的话估计会被人打死
xxl11231220
2018-09-26 10:19:22 +08:00
求之不得。表示嫌弃不写少些注释的
FifiLyu
2018-09-26 10:28:53 +08:00
代码应该做到自解释,你这样如果精力不够时,很容易出现注释和代码不同步,最终更加误导人。
junbaor
2018-09-26 10:32:56 +08:00
看起来这是个稍微底层的方法,这注释写的,完美~
northernlights
2018-09-26 10:35:00 +08:00
@looseChen 我可没这本事,看来你经验丰富,你自己去吃吧。
tiedan
2018-09-26 10:37:48 +08:00
待过一家公司都不让写注释
noNOno
2018-09-26 10:38:16 +08:00
还是蛮好的
ioth
2018-09-26 10:39:02 +08:00
我会比较尊重这样的孩子。
Mavious
2018-09-26 10:48:46 +08:00
作为新手,最喜欢注释多多的代码了,每一行的功能都能靠注释看懂。
多多益善。
ljspython
2018-09-26 10:49:37 +08:00
注释永远不嫌多
nomemo
2018-09-26 10:49:51 +08:00
挺不错的,就是要持续维护
AllenW
2018-09-26 10:52:34 +08:00
这注释 厉害了
sorra
2018-09-26 10:55:28 +08:00
写错了才挨打

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

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

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

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

© 2021 V2EX