《代码整洁之道》--第4章 注释

第4章
　　注释是一种失败，我们无法找到不用注释就能表达自我的方法，所以总要有注释，这不值得庆贺。

　　1. 注释不能美化糟糕的代码
　　　　a) 与其花时间编写解释你搞出的糟糕的代码的注释，不如花时间清洁那堆糟糕的代码
　　2. 用代码来阐述
　　　　a)

　　　　

　　3. 好注释
　　　　a) 法律信息
　　　　　　

　　　　b) 提供信息的注释
　　　　　　

　　　　c) 对意图的解释
　　　　　　

　　　　d) 阐释
　　　　　　

　　　　e) 警示
　　　　　　

　　　　f) Todo注释
　　　　　　

　　　　g) 放大（放大某种看来不合理之物）
　　　　　　

　　　　h) JavaAPI中的doc
　　4. 坏注释
　　　　a) 楠楠自语
　　　　　　

　　　　b) 多余的注释
　　　　　　

　　　　c) 误导性注释
　　　　　　有时候多余的注释会间接的进行误导
　　　　d) 循规式注释
　　　　　　不需要每个方法和每个变量都需要注释
　　　　e) 日志式注释
　　　　　　每一次编辑完代码，就在模块开始添加一条注释
　　　　　　

　　　　f) 废话注释
　　　　　　

　　　　g) 可怕的废话
　　　　　　Javadoc也可能是废话，下列javadoc的目的是什么，答案：无

　　　　　　

　　　　h) 能用函数或变量就别用注释（java内存机制）
　　　　　　

　　　　i) 位置标记
　　　　　　

　　　　j) 括号后面的注释
　　　　　　只会给我们愿意编写更短的，封装的函数的愿望
　　　　　　

　　　　k) 归属与署名
　　　　　　

　　　　l) 注释掉的代码  git,svn
　　　　m) Html注释
　　　　　　

　　　　n) 非本地的信息
　　　　　　除了可怕的冗余之外，还给出了有关默认端口的信息。不过那个函数完全没有控制到那个所谓的默认值。
　　　　　　

　　　　o) 信息过多
　　　　　　别在注释中添加有趣的历史性话题或者无关的细节描述
　　　　　　

　　　　p) 不明显的联系
　　　　　　

　　　　q) 函数头
　　　　　　为只做一件事的短函数选个好名字，比写好函数头注释要好