继续读《代码整洁之道》。
认为写注释就表示一种失败,因为你的代码让人不明白,才需要注释,某种程度上来说也不无道理。
代码会有修改,但注释却不一定及时维护,时间越长,注释和实际情况的差别就可能越大。
通过一个与注释意义相同的函数来代替注释,比如
// Check to see if the employee is eligible for full benefits
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))
不如改成
if (employee.isEligibleForFullBenefits())
作者也列出一些需要用注释的情况,不过原则还是尽量用代码本身去表明准确的意图。如果要写,注释要精确,一定要真有用,如果根本就不需要看这注释,就不要为了添加注释而加注释
“直接把代码注释掉是令人讨厌的做法”,实际项目中,我倒是经常会这么干,因为项目经常会有调整,有时候这样做,有时候那样做,所以不想将旧的删除,因为后面还会用到。通过版本管理工具去看旧代码,理论是这样,虽然 Git 能看到过去的代码,但是真想用,那么多提交历史,要一个一个看,是哪次修改动的这块代码,实在浪费时间。
注释里写 html 标签令人讨厌,我也这么认为。