注释? 坏东西! -(代码整洁之道 注释篇)

519 阅读2分钟

每个程序员都不可避免的需要写注释, 曾经也有人说过,好的注释胜过好的代码,但是鲍勃大叔在其《代码整洁之道》一书中,给出了完全不同的看法:
以下是对全篇的摘要概括:

注释就是坏的! 坏的! 坏的!

  1. 别给糟糕的代码加注释—— 重新写吧! -Brian W.K P.J Plaugher

  2. 注释并不全是好的 ,事实上, 注释最多就是一种必须的恶 。 如果编程语言足够具有表达力,或者我们写出能够表达含义的代码,那么就不需要注释!(当然你需要英文足够好)

  3. 注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败!

  4. 注释是会撒谎的,注释存在的时间越久,离其所描述的代码越远。因为程序员不能坚持维护注释

  5. 与其花时间给你搞出的糟糕代码加注释,不如花时间清洁那堆糟糕的代码。

  6. 只需要花费几秒钟就能用代码解释你的意图,而不是注释(创建一个描述事物的函数即可)

  7. 能用函数名和变量名表达意图就别用注释

  8. 尽量少用标记栏。

  9. 直接把代码注释掉是讨厌的做法,因为其他人不敢删除注释掉的代码,他们会想”代码依然在那儿,一定有原因,不能随便删除”

  10. 好的注释有: 法律信息,警示,todo注释,提供信息的注释,对意图的解释,当然能用函数来表达意图是最好的。

  11. 坏的注释有: 喃喃自语,多余的废话,误导性注释,日志性注释,位置标记,注释掉的代码,信息过多,短函数头