《clean code》第三章 注释

若编程语言足够有表达力，或者我们长于用这些语言来表达意图，就不需要注释。

好注释：

    a.法律信息

    b.提供信息的注释（如，解释返回值的意思）

    c.阐释（阐释部分代码意思）

    d.警示

    e.todo注释

    f.公共api中的javadoc

坏注释：

    a.喃喃自语

    b.多于的注释

    c.误导性注释

    e.循规式注释（例如每个函数都要有javadoc）

    f.日志式注释

    g.废话注释