建站行业成为买方市场,wordpress禁用主题更新,玉溪市网站建设,水溶花边外发加工网不出意外#xff0c;Linus又开喷了#xff0c;这次的激情开麦#xff0c;源自一部分没有做注释的合并请求#xff1a;Linux6.3内核收到了一部分合并请求#xff0c;但这部分合并完全没有注释。 如果你懒得解释为什么存在一个合并#xff0c;那这个合并从本质上来说就是错…不出意外Linus又开喷了这次的激情开麦源自一部分没有做注释的合并请求Linux6.3内核收到了一部分合并请求但这部分合并完全没有注释。 如果你懒得解释为什么存在一个合并那这个合并从本质上来说就是错误的垃圾这是每个开发者都应牢记于心的规则。我重复一遍如果你不能解释清楚这个合并请求那就不要做就是这么简单。——Linus Torvalds 让Linus如此生气的代码注释到底有啥用
注释不仅展现了代码背后的逻辑让我们在后期维护时能更容易阅读、理解代码还能将授权许可、版权信息编写进去。此外注释也有提示作用如标记为FIXME或TODO的注释往往表示待定的工作等等。
总之代码注释告诉了我们为什么会写这样的代码。对Linus来说收到的合并请求缺乏注释因为没有合理的解释代码不仅变得毫无意义还会变得更难读、难维护。所以代码注释很重要编写合理的代码注释更重要。 编写注释快看这三不要
1.不要花大力气编写注释解释代码的每一个细节
过多的注释会让源文件变得非常混乱不仅会降低代码的可读性还难以维护。这种写大量注释的行为也很难不让Linus发火。
2.不要留不恰当的注释
很多人会通过注释保存代码演变的历史记录但这往往是无用功。一个热知识版本控制系统可以保存历史记录。还有一些过时的、被废弃的、不正确的注释一经发现就需要尽快更新或删除不能再让这些废弃注释误导我们了
3.不要犹豫看到注释掉的代码请直接删掉它
对于那些不再使用的旧代码大家可能下意识会直接注释掉但直接干脆利落删除掉这些旧代码会更简洁。毕竟后期维护的时候大家面对这些注释掉的代码只会敬而远之。
重构吧
通过重构那些烂代码可以摆脱不必要的注释
命名比如将变量i重命名为numGoals能明确意图。对于变量、方法以及类我们都可以这样做结构如果某一段代码没有注释就无法理解可以尝试更改代码结构子表达式将一个复杂的表达式拆分为多个子表达式可以帮助大家更好地理解代码断言当我们遇到“当某个条件为真时某段代码才能正常运行”的情况时可以引入断言标明假设。
这样才能使注释更简洁、易看。
如何编写好的代码注释
以下几个注释模式送给大家
文档注释模式记录接口而不是解释代码本身。脚注注释模式主要用于描述为什么采用特定方法短小精悍。通常在无法从代码中推断出此类信息的情况中使用。警告注释模式警告开发人员注意某些特殊需求的注释如以超级管理员的身份调用函数。警告可能涉及安全或设计缺陷注释可能包括TODO或FIXME。签名注释模式注释中加上开发人员的首字母缩写。在团队中我们可以更快速地找到相应人员讨论。编织代码模式代码和文档结合在一起。需要首先编写文档然后对该文档进行编码。
在Linus看来写代码非常重要写好的代码更重要。注释、命名、版式等代码规范检验的正是程序员最重要的基本功如果基础不牢必定地动山摇。
