Note4代码简洁之道-Chapter4

1. 注释的的恰当用法是弥补我们在用代码表达意图时遭遇的失败。
2. 程序员应该花更多的心思把代码的真实意图表达清楚，准确。
3. 注释不能美化糟糕的代码。
4. 有时候代码本身不足以解释其行为。

if(person.isNew & HOURLY_FLAG)&& person.age>65)
                      or 
if(person.isEligibleForFullBenefits())

5. 真正的好的注释是你想办法不去写的注释。
6. 注释可以放大某种看来不合理之物的重要性。
7. 想想如果没有JAVA doc我们该如何使用JAVA API？
8. 简单的函数是多余的。
9. 拒绝写废话注释。

/**
* Return the day of the month.
*/
public int getDayOfMonth(){
  return dayOfMonth;
}

10. 直接把代码注释掉是讨厌的做法。直接删掉，我们有先进的源代码系统如此之久，这可以直接删掉。

writeNote();
// writePaper();
writeEnd();