代码整洁之道 注释

注释

1. 不要给糟糕的代码写注释，重新写吧。
2. 好的代码根本不需要注释。
3. 注释总是一种失败，因为我们无法找到不用注释就能表达自我的方法。
4. 注释会撒谎，程序员往往不能坚持维护注释。不准确的注释要比没有注释更糟糕。
5. 尽管有时候需要注释，但是我们应该多花心思减少注释。
6. 每个函数、变量都要有Javadoc是愚蠢可笑的。
7. 不要有注释掉的代码，直接删掉。
8. 去掉注释中的HTML标记。

好注释

唯一好的注释是你想办法不去写的注释。

法律信息

提供基本信息的注释

对意图的注释

警示

TODO注释

公共API中的Javadoc