代码整洁之道（四）---------------------注释

      别给糟糕的代码加注释---------------重新写吧！

 

     什么也比不上放置良好的注释来得有用，但什么也不会比乱七八糟的注释更有本事搞乱一个模块。若编程语言足够有表达力，或者我们常用这些语言来表达意图，就不需要那么多的注释，也根本不需要。如果你要写注释，想想看是否有办法翻盘，用代码来表达。

    我为什么不推荐写注释，很简单，程序员不能坚持维护注释。所以注释并不可靠。代码在变，在演化，从这里移到那里，彼此分离、重造又合到一起。有时候是不会跟着动，就常常会跟所注释的代码分开，孑然飘零愈来愈不准确。

    真实只在一处地方：代码。只有代码告诉你他在做什么，那是唯一真实准确的信息来源，所以尽管有时也需要注释，我们也该花心思尽量减少注释量。

   所以要明白：（1）注释不能美化代码，（2）尽量用代码来表达。

   但有时候注释也是必要的， 比如注释需要添加到如下地方：

  （1）版本，版权，法律信息

  （2）提供信息

       比如你有一个正则表达式需要匹配，你可以在表达式旁边添加正确匹配的字符串的注释。

  （3）警示作用的注释

  （4）表达意图

  （5）TODO注释

  总之，你写的注释切忌不是你的自说自话。变量、函数尽量不加注释，注释掉的代码要删除，容易产生误导注释不要加。