代码整洁之道精华——第四章 注释

阅读本文有两种原因：第一，你是个程序员；第二，你想成为更好的程序员。你如果想成为更好的程序员，那就请细细品味文章内容，它绝不会让你失望。
代码整洁之道教给大家如何编写整洁的代码，而不仅仅是能运行的代码，这对于编程者而言很重要。我在读这本书的第一遍时没什么感觉，但在读第二遍时觉得它确实挺不错的，如果有机会的话我会读第三遍。下面是我在读书过程中摘录的精华内容，希望大家认真对待。各位看官如果读完本文觉得书中的精华内容挺合自己的胃口，那就可以抽出时间认真地读一下这本书。

1、注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。注意，我用了“失败”一词。我是说真的，注释总是一种失败。我们总无法找到不用注释就能表达自我的方法，所以总要有注释，这并不值得庆贺。
如果你发现自己需要写注释，再想想看是否有办法翻盘，用代码来表达。每次用代码来表达，你都该夸奖一下自己。每次写注释，你都该做个鬼脸，感受自己在表达能力上的失败。
2、真实只在一处地方有：代码。只有代码能忠实地告诉你它做的事，那是唯一真正准确的信息来源。所以，尽管有时也需要注释，我们应该花心思尽量减少注释量。
3、写注释的常见动机之一就是糟糕代码的存在。我们编写一个模块，发现它令人困扰、乱七八糟。我们知道它烂透了。我们告诉自己：“最好写点注释！”不！最好是把代码弄干净！带有少量注释的整洁而有表达力的代码，要比带有大量注释的零碎而复杂的代码像样的多 。与其花时间编写解释糟糕代码的注释，不如花时间整理那堆糟糕的代码。
4、任何迫使读者查看其他模块的注释，都没能与读者沟通好，不值所赞。
5、用整理代码的决心替代创造废话的冲动吧。你会成为更优秀、更快乐的程序员。
6、你如果发现自己想标记右括号，其实应该做的是缩短函数。

public static void Main(string[] args){    BufferedReader in = new BufferedReader();    string line;    int lineCount = 0;    int charCount = 0;    int wordCount = 0;    try{        while((line=in.readLine()) != null){            lineCount++;            charCount += line.Length();            string[] words = line.split("\\w");            wordCount += words.length;        }//while    }//try    catch(IOExcewption ex){        System.out.println("Error:"+ex.getMessage());    }//catch}//main

7、直接把代码注释掉是非常讨厌的做法，别这么干。如果你这么干了，其他人也就不敢删除注释掉的代码。他们会想，代码依然在那儿，一定有其原因，可能这段代码很重要。注释掉的代码堆积在一起，就像破酒瓶底的渣滓一般让人恶心。
8、能用函数或变量表达清除他所做的事时就别用注释。

抛开所有细节不谈，代码整洁之道总体来说可以分为以下7点：

• 运行所有测试
• 减少重复代码
• 提高表达力
• 提早构建简单抽象
• 类和方法都只做好一件事
• 尽量减少类和方法的数量
• 努力，让营地比你来时更干净。努力，让世界比你来时更干净。努力，让代码比你签出时更干净。