代码简洁之道——注释

只有代码能忠实的告诉你它在做什么事，尽管有时候也需要注释，我们也该花心思减少注释量；

（1）注释不能美化糟糕的代码：与其花时间编写解释你写出的糟糕的代码的注释，不如花时间清洁那堆糟糕的代码；

（2）用代码来阐述：少写注释，尽量直接用代码表达；

（3）好注释：a、法律信息；

                          b、提供信息的注释；

                         c、对意图的解释；

                         d、阐释：对某些晦涩难明的参数或者返回值进行阐释；

                         e、警示；

                          f、TODO注释；

                         g、放大：放大某种看来不合理之物的重要性；

                         h、公共API中的Javadoc。

（4）坏注释：a、喃喃自语；

                           b、多余的注释；

           c、误导性的注释；

  d、循规式注释；

  e、日志性注释；

                           f、废话注释；

  g、可怕的废话；

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

                         i、少用位置标记；

                         j、括号后面的注释：应该用短小、封装的函数把代码缩短；

                        k、归属于署名；

                        l、注释掉的代码：这个深有感触一定要删掉；

                      m、HTML注释；

                       n、和本函数没有关系的注释；

                      o、不明显的关系；

                      p、信息过多；

                      q、函数头：应该写一个函数头，而非写一个好的注释。