Linux 6.3 内核的合并窗口已开启,Linus Torvalds 也收到了大量的 PR,目前总体看来正在有序进行。但 Linus 对部分合并请求的日志信息非常不满:“我之前就已经说过,很显然现在我需要再重复一次,如果你懒得解释为什么会存在这个合并请求,那么根据定义,这就是一堆垃圾!”
▲缺少注释的合并请求让 Linus Torvalds 很生气
Linus 认为,如果你不能解释清楚一个合并请求,那么就不要提交,这是很简单的道理。如果不解释提交合并请求的原因,那就是在生产垃圾。在这种情况下,Linus 觉得这种合并请求根本就不应该存在。
Linus 强调道,这是每个开发者都应该牢记的规则。如果有注释的话,那就在日志信息中写出来,让那个合并请求的提交看起来合理些。
现在这些没有注释的合并请求看起来完全没有意义,Linus 表示自己十分厌恶无意义的合并。它们只会让代码历史看起来更糟糕,更难读。
最后的结果是,这次合并是对之前的 Linux 6.2 的修复,相关的开发者会努力在未来更清楚地表达合并请求的注释。
1)解释型注释,基本就是废话;
2)过期型注释,与代码不同步更新,也是低级;
3)错误型注释,注释与实际的代码逻辑,相差甚远,误导人的低级描述;
4)高端重点型注释,关键核心代码的思想解析,对理解源码的重点起着关键性作用;
5)无代码注释,这种就算是高手写的,但是没有关键性的核心注释,不配称之为:优秀程序猿。