《代码整洁之道》--第四章

什么也比不上放置良好的注释有用。什么也比不上乱七八糟的注释更有本事搞乱一个模块。什么也不会比陈旧、提供错误信息的注释更有破坏性。

带有少量注释的整洁而有表达力的代码，要比带有大量注释的零碎而复杂的代码像样的多。

有些注释是必须的，不过要记住，唯一真正好的做法是想办法不写注释。

好注释包括：法律信息、提供信息的注释、对意图的解释、阐释、警示、todo注释、放大某种看起来不合理之物的重要性、公共api中的javadoc

大多数注释都是坏注释，都是糟糕代码的支撑或借口，或是对错误决策的修正，例如：误导性注释、循规式注释、日志式注释、废话注释、喃喃自语型、位置标记、括号后面的注释、注释掉的代码、html注释、信息过多、不明显的联系、非公共代码中的javadoc。