代码整洁之道（整理三：注释）

背景：接上回。上回说的是函数，这回说注释。

总结提前：注释这里能说的很简单：大部分的注释都是low的，都是无用的，都是废话。能不写尽量不写。

1. 别给糟糕的代码写注释，重新写吧！
2. 什么也比不上放置良好的注释来的有用。什么也不会比乱七八糟的注释更能捣乱。什么也不会比陈旧、提供错误信息的注释更具有破坏性。
3. 注释并不“纯然地好"。很多时候，注释是一种恶，如果代码有足够、清晰的表达意图，就不需要注释。注释只能说明我们代码表达意图的能力的失败，因为你发现你的代码既然需要注释才能让人看懂，这并不值得庆贺。
4. 如果你发现自己需要写注释，你应该从优化代码表现力层面来解决。

一、为什么注释这么坏
1、因为注释会撒谎。不是说总会撒谎，但是很多情况下会这样，注释存在的时间越长久，就离所描述的代码的本意越远，原因很简单，程序员不会坚持对注释进行维护。
2、代码会变动、会变迁。会分离、重造，但是注释不能总是随之变动，不能总是跟着走，会越来越不准确。

虽然说程序员应当负责将注释保持在可维护、有关联、精确的高度。但是，更主张把力气用在写清楚代码上，直接保证无需写注释。

不准确的注释要比没有注释要坏的多。永远只有代码能忠实的告诉你它做的事情，那是唯一准确的。

喃喃自语的注释，每个过程都添加注释，有时间写这么多注释，你不如打磨一下代码。

二、注释不能美化糟糕的代码
带有少量注释的整洁而有表达力的代码，要比带有大量注释的零碎、复杂的代码像样的多。

三、并不是说注释全是坏的
1、比如警告：警告看这个代码的人，为什么要这么写，这个的重要性。
2、tod注释。
3、公共api的javadoc。因为这个是公开的，别人不会看你的代码，只需要知道怎么用就可以。
4、注释调的代码的注释。注释调一段代码，必须写注释，说明出于什么原因注释这段代码，否则，后人不敢动这个注释的代码，到时候，这些代码堆积在一起，就会很乱。

四、多余的注释
1、误导性的注释。既然觉得写注释，你的注释一定要让人很容易看懂，否则别人看半天，浪费时间不说，还起到误导的效果。
2、每个函数每个变量甚至每个过程都写注释，更是可笑的。这会让代码变得很散乱。
3、日志式注释。
每个人修改过这个方法，都写一个注释上去。这个也有点可怕。