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

2022-05-30 09:45:29 +08:00
 nuanshen
14159 次点击
所在节点    程序员
155 条回复
BeautifulSoap
2022-05-30 14:05:12 +08:00
说真的,你们学了这么多年业务代码,难道都理解不到代码只能告诉你做了什么,但不会告诉你为什么要这么做的道理吗?
业务代码比注释里写做了什么,写清楚为什么要这么做,这是哪个业务逻辑。尤其是这个业务逻辑对应的资料在哪,链接在哪更加重要
Biwood
2022-05-30 14:06:51 +08:00
注释是为了解释代码本身无法表达的部份,而不是重复代码内容
shm7
2022-05-30 14:08:48 +08:00
谁说了这句话,下次让他自己在头上贴一张大大的“人”字,不然大家不知道 ta 是人啊。

然后覆盖 20000 字的当前职位职能介绍吧,否则大家不知道他是谁。下班了回家,重写 20000 字。出去玩,重写 20000 字。
newaccount
2022-05-30 14:16:09 +08:00
写的时候:注释?写个屁的注释!老子的代码是自说明的!
读的时候:卧槽!哪个傻 X 写的代码!特么的注释都不写的啊!
BeautifulSoap
2022-05-30 14:24:56 +08:00
@BeautifulSoap 靠,怎么打字打得错误连篇,重新修正一下:

"说真的,你们写了这么多年业务代码,难道都理解不了代码只能告诉你做了什么,但不会告诉你为什么要这么做的道理吗?
业务代码的注释把为什么要这么做,对应的是哪个业务逻辑,这个业务逻辑对应的资料在哪写清楚更重要。”

最近管理项目知识,深刻意识到了管理好领域知识,并将具体代码和领域知识对应起来是多么重要的一件事
nekoneko
2022-05-30 14:25:15 +08:00
@zppass #50 这样说, 那些源码作者该负荆请罪才是.
nightwitch
2022-05-30 14:30:12 +08:00
"好的代码不需要注释": 只适用于搬砖代码

复杂点的算法论文十几页都不一定能讲清楚,想靠硬啃代码看懂纯属扯淡
nanjoyoshino
2022-05-30 14:35:16 +08:00
差不多,尤其是对开源代码,注释详细的读起来真的很舒服
SimonOne
2022-05-30 14:37:50 +08:00
那你觉得业务该不该写一下在注释里呢,不写下一个顾问倒是能看懂代码,但是也许不知道这段代码是不是符合业务。
FallenTy
2022-05-30 15:04:52 +08:00
希望你们能在半年后不看注释秒懂自己写的代码
GeruzoniAnsasu
2022-05-30 15:08:16 +08:00
注释是好的
坏注释是坏的
比起「注释比代码多是好的」,「测试代码比逻辑代码多是好的」的准确性更好
qingshuang
2022-05-30 15:09:57 +08:00
@Seayon 你这里用 payTime 和 id 的联合索引不就好了嘛 payTime>= AND id>
xuanbg
2022-05-30 15:10:46 +08:00
注释就和日志一样,不好好写非但不起什么作用,反而影响到对代码的正确理解。
luzemin
2022-05-30 15:14:12 +08:00
这代码还要注释吗?注定只能 35 岁后的我自己维护

https://imgur.com/a/zuVy8sr
puzzle9
2022-05-30 15:30:34 +08:00
```
$my_girl_friend = function ($self, $girl) {
$age = $girl->age;
if ($age > 18 && $age < 25) {
$height = $girl->height;
if ($height > 150 && $height < 180) {
$face = $girl->face;
if ($face > 60 || !$face) {
$money = $girl->money;
if ($money || !$money) {
// 性格
$character = $girl->character;
return $character && $self;
}
}
}
}
};

$girl = new Girl(...);
```
zooeymango
2022-05-30 15:52:36 +08:00
代码好不好跟注释的多少不是强相关,一般来说复杂逻辑、传参是需要注释,但是这是因为代码表达不出来这些内容,如果只是单纯复述代码,那就根本不需要加,而且注释也是需要维护的,如果不能同步维护,反而是累赘
m102
2022-05-30 16:12:32 +08:00
做事用心吧,就像好厨师

做饭前后的 锅 碗 瓢 盆 调 料 厨 具 都码得整整齐齐,干干净净一个道理。

后面轮班的厨师也好开工。
paoqi2048
2022-05-30 16:17:38 +08:00
反正我写
DeepRedApple
2022-05-30 16:45:05 +08:00
我觉得只要代码一眼能看出是什么功能的,就不用写代码,如果不是能够马上看出什么功能的,就会写代码,如果涉及到涉及设计模式之类的,也会写。
chenmobuys
2022-05-30 17:15:14 +08:00
没有什么事情是绝对的,话别说的太死

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

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

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

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

© 2021 V2EX