诸位对“好的代码就是要注释比代码还多”这句话怎么看?

2022-05-30 09:45:29 +08:00
 nuanshen
14142 次点击
所在节点    程序员
155 条回复
wasd6267016
2022-05-30 09:48:05 +08:00
高手的好的代码是自注释的
如果做不到,那就多写点注释吧
NoNewWorld
2022-05-30 09:48:27 +08:00
这话是对普通人说的,,牛逼的人写出来的,代码就是注释
122006
2022-05-30 09:49:49 +08:00
自己也需要写注释给几分钟后的自己看
yuzo555
2022-05-30 09:50:10 +08:00
某种意义上说没错,但充分性和必要性别搞反了。
dqzcwxb
2022-05-30 09:51:23 +08:00
来自 java.lang.Object#toString
hyqCrystal
2022-05-30 09:53:49 +08:00
看下 spring 的源码 注释确实多,挺好的
echo1937
2022-05-30 09:55:09 +08:00
高手的代码是自注释的:代码应该简洁易懂,很容易让人明白这段代码是在干什么 -- for what 。

现实工作中代码还应该讲清楚 why ,比如一些业务逻辑的细节,这种需要文档或者注释尽可能详实完备。
wherewhale
2022-05-30 09:56:42 +08:00
就国内这普遍风气和水平
大部分还是要靠注释理解代码怎么跑的
clove
2022-05-30 09:56:52 +08:00
可阅读的代码胜过面面俱到的注释。
retrocode
2022-05-30 09:58:50 +08:00
问题在于不同人对"好"的代码定义不同, 以"好"代码为理由不写注释的人, 代码一定不是"好"的代码
brader
2022-05-30 09:59:38 +08:00
还注释,我没在注释里撒谎你就该偷笑了
wqhui
2022-05-30 09:59:57 +08:00
尽量让人看到函数名或者字段名就知道这是大概做什么的,注释是更详细的解释。遇到命名成屎的函数跟字段,最应做的是重名他们,而不是用一大段注释去解释
snoopyhai
2022-05-30 10:02:03 +08:00
多不多其实不重要. 好才关键, 如何算好?

写清楚方法体的用途, 逻辑, 以及为什么这么做.
还有最重要的一点. 是谁在什么时候让你这么做的.

Jooooooooo
2022-05-30 10:03:05 +08:00
这和"对绝大多数人来讲, 没到拼天赋的地步"是一个道理.

好的代码风格之类的东西当然重要, 但不如从注释入手.
abersheeran
2022-05-30 10:04:37 +08:00
我就很少写注释。😓除非是写复杂逻辑,否则注释除了让作者和读者都费劲以外,没什么作用。
akatquas
2022-05-30 10:05:44 +08:00
代码 self-explanatory 是逻辑使然。comment 是业务缘由,也可以用来甩锅。
gam2046
2022-05-30 10:06:28 +08:00
合理。各种优秀的开源项目,都需要大量的注释和文档,Spring 全家桶,没几个人会自己看代码。Android 也同样是看文档,看方法说明就直接上去一把梭。

其他各类语言,.net 啥的,也是以文档、注释优先。似乎只有 C/C++项目,注释量会稍微少一些。

如果你认为自己写代码,没有注释完全也能看得懂,并且自己在一个月后还能知道当时为什么这么写,那就可以不写注释,挑战一下自己。

我尝试过是失败了,两个月后同事问我改需求,自己都看的一愣一愣,心中暗骂自己瓜皮。
wangtian2020
2022-05-30 10:07:32 +08:00
前端。
自己写的代码不写注释都能很快读懂,对自己个人来说写注释的意义不大。
写注释的好处(作用),可以很快明白一段代码的作用,否则可能需要阅读一会。另外可以给让别人更快理解。
不写注释的好处,省力,这点很重要,没必要上班多干没必要的活。
团队如果有要求就写,没要求就不写,不主动写。
cmdOptionKana
2022-05-30 10:08:54 +08:00
如果问你对 “黄河之水天上来,飞流直下三千尺”,你不会分析是不是真的天上来,具体是多少尺吧?

人类的语言有字面意思,也有修辞手法,比如一种手法叫做“夸张”。

因此我认为,与其只看这句话的字面意思,还不如把它理解为 “注释很重要”,不需要纠结是否一定要比代码多(这也太耿直了吧!)
Leviathann
2022-05-30 10:11:40 +08:00
库代码和业务代码不一样

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

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

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

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

© 2021 V2EX