写代码注释的注意事项
首先要明白，好注释并不是用于重复代码，或是解释代码（你会这门编程语言就能读懂，为什么还要通用语言解释呢。如果代码过于复杂，应该加以重构，而不是花费大力气去解释它）。
而是以一种高层抽象解释你的意图是什么（好比解释你的业务要做什么）。
当然，坏注释会产生反效果，如无关的注释和错误的注释等。
有三种注释是值得建议的：
- 概述性注释：将若干行的代码的意思以一两句话说出来，便于他人阅读你的代码。
- 目的性注释：指明代码的意图，告诉人家你要解决什么问题（但无需说明怎么解决）。
记住，注释无需太多，太多的注释可能会带来反效果。我曾有段时间，几乎想在每一句代码上加注释。后来再看回来，其实很多都是解释代码注释。即使没有这样的注释，别人也能轻易读懂我的代码。那这样的注释就是不该出现的。
还有一点就是先写注释再写代码比先写代码在写注释要好。正如前面所说，注释属于高层概述。当你明白了做什么，你的代码就会水到渠成一些。
避免使用行尾注释，但有两个例外：
- 行尾注释用于数据声明。（如temp是干什么用的）
- 用行尾注释标注块尾。（当代码块很长，你就知道这种行尾注释的重要性了）
不要注释投机取巧的代码，应该要重写它。（不要不舍得写过的那些投机取巧的代码，因为可能会给别人带来阅读糟糕注释的体验）
至于最佳注释量，IBM研究发现，每十条代码语句有一条注释，在这样的密度下，程序的清晰度最高。其实这个并不重要，重要的是你的注释有它的价值。
总之，注释真的很重要，前提是你写的是好注释。
