《代码整洁之道》之四 注释

　　注释是对程序代码的补充，是一种不得已而为之的行为。所以，在我们需要给程序添加注释之前一定要认真考虑一下程序是否符合前面几节提到的原则。试着想一下可否通过优化程序流程，结构优化，或者取一个合适的名字，从而使程序变得易读。

　　总之，尽量不要添加注释。

　　但是，随着工作的时间越长我们什么事都会遇到，也会遇到不得不添加注释的时候。当碰到这些情况的时候，我们需要注意一些原则。

　　注释应该添加必要的警告或法律信息，或者是对某些意图的阐释，或者是TODO注释。

　　除此之外，还有些注释是不必要的或者是可能引起混乱或误解的注释，比如：

　　　　一些自说自话的注释

　　　　循规式注释，譬如每个函数都要写Javadoc或者给每一个变量注释；

　　　　日志式注释

　　　　位置标记  等等

　　当然，我最讨厌的注释就是注释掉的代码，信息量过多的注释。

 

　　总之，我觉得注释应该坚持的原则：注释要准确，注释是为了提高代码的可读性，能用函数或变量时就别用注释。