常见错误1：过分积极的注释

最有效率的代码是根本不存在的代码，最好就是要注释的代码自注释。

不应该把更改日志作为注释插入到源文件的头部或者尾部。

代码增加一页，理解难度就大了一倍。

注释要随着它描述的代码的更改而更改。

遵循简单易行、定义良好的命名习惯，函数声明中形式参数的名字尤其重要。

采用标注库中的、人尽皆知的组件。

注释不应该描述显而易见的东西，或把在别的地方已经说清楚的东西再说一遍。

在代码容易理解和维护的前提下尽可能少写注释。