代码整洁之道【书】--04

注释：

注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。我们总无法找到不用注释就能表达自我的方法。

不准确的注释要比没注释坏的多。注释不能美化代码。

//TODO注释     程序员认为应该做，但由于某种原因还么有做

//有时候注释还没有比代码描述明确

误导性注释：词不达意

循环式注释：

日志式注释：

废话注释：喋喋不休，毫无新意

可怕的废话： /*the name*/  PRivate string name;

能用函数或变量时就别用注释

总结一点：注释是：少 快 好 省

以上信息来自《代码整洁之道》