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

2022-05-30 09:45:29 +08:00
 nuanshen
14159 次点击
所在节点    程序员
155 条回复
Macolor21
2022-05-30 12:01:22 +08:00
注释是写为什么,而不是写是什么
AyaseEri
2022-05-30 13:02:22 +08:00
你像 Java 那个 toString ,我表示不可以,一大片绿油油的注释里面夹点代码,readability 为负
SheHuannn
2022-05-30 13:03:39 +08:00
如果需要大量的注释去解释一段代码,那这段代码可能就需要重构了;好的代码,代码本身就是注释了。
taest
2022-05-30 13:05:17 +08:00
其实作为中国人,我对汉语的敏感度更高,所以我写中文注释,也喜欢看有注释的代码
goobai
2022-05-30 13:05:20 +08:00
建议评论区的高手以后都尽量别写注释了😄
taest
2022-05-30 13:06:06 +08:00
方法名或者参数名写的再好,我还是不如中文注释来的敏感
adoal
2022-05-30 13:20:24 +08:00
要分清以注释面貌出现、给 external caller 看的文档,和不做为文档、给 internal maintainer / reviewer 看的真正注释
oldshensheep
2022-05-30 13:20:33 +08:00
@AyaseEri 别说 Java 了,Java 的文档机制是很完善的,IDE 的支持也很好。楼上没有开阅读模式,而且对于标准库文档我认为越详细越好。
chimission
2022-05-30 13:20:34 +08:00
@cmdOptionKana 虽然但是, 这不是一句,原文是两句
greatbody
2022-05-30 13:25:55 +08:00
对于商业项目,如果有 JIRA 或者 AzureDevOps 等卡墙支持,可以考虑在 commit 中指定卡号。这样看起来有疑问的代码就直接去看 commit 记录及相关联的卡。
springz
2022-05-30 13:38:54 +08:00
业务代码经常修改的不建议写注释,底层代码还是要尽量写单元测试和丰富的注释。
Hieast
2022-05-30 13:39:03 +08:00
这个得看 ROI 。
如果一段代码预期会被很多人看,比如面向外部的、基础的、框架性质的代码,那么不仅要解释每个参数的含义,还要说明使用场景。甚至按照文档生成工具的标准单独生成文档。
如果一段代码只有开发者看,那么把代码写好就行,实在无法自解释的逻辑加注释。
如果一段代码除了自己谁都不看,比如就自己用的小脚本,那想怎么写怎么写。
springz
2022-05-30 13:41:03 +08:00
业务代码非常容易出现代码和逻辑改了,注释没同步这种事情。看做的是什么类型的。
tkHello
2022-05-30 13:41:49 +08:00
资本阶级给无产阶级灌输的观念罢了
amwyyyy
2022-05-30 13:46:54 +08:00
大部分人写的就是一坨屎,还以为自己是好代码不写注释。
yuancoder
2022-05-30 13:46:58 +08:00
代码本身就在表达你的逻辑
BigDogWang
2022-05-30 13:50:35 +08:00
代码自注释就是扯淡,代码命名、结构好,只能自解释流程,业务细节呢?算法细节呢?不注释看毛线呢
laviris
2022-05-30 13:54:35 +08:00
对这句话的理解是,需要加上限制条件“在增删改查领域”。稍微运用点算法或者设计,没有注释,也许能看懂,但是有注释可以让看懂的时间缩短到 10%内
FreshOldMan
2022-05-30 13:56:12 +08:00
不少人比较高估自己拉💩的水平,不写注释,怕不是隔了一年,自己都不敢动💩
QiuXX
2022-05-30 13:59:05 +08:00
我有强迫症就喜欢写注释

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

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

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

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

© 2021 V2EX