正在阅读：关于脚本中注释的五点建议关于脚本中注释的五点建议

　　当你学习某代码技术已经基本入门以后，自然会注意到提高代码质量的重要性，而书写注释则是提高代码质量的第一关——可能也是最容易的一关。以下是我总结的关于书写注释的一些建议！

　　一、切勿为了注释而注释！

　　为代码添加注释的最主要目的是提高代码可读性，但这里面还有一个心态问题：如果你认为，写了注释，就可以提高代码质量，就可以证明实力，那就错了，事情并没有那么简单。

　　相信一定有人在写注释的时候，没有把握正确的心态，这就导致写出来的注释往往不合时宜。什么是不合时宜的注释？我就写过这样的注释：

　　……
　　'打开记录集，记录Orders表所有数据
　　objRS.Open "SELECT * FROM Orders",objConn,1,1
　　……
　　objRS.Close '关闭记录集
　　Set objRS=Nothing '释放记录集对象
　　……

　　明白了吧？这就是不合时宜的注释的情形之一：形式化的注释，往往会成为代码的累赘，甚至无法突出真正需要注释的地方，降低了代码的可读性。

　　这都是心态没有把握好的原因。如果能正确把握心态，就会把心思放到提高代码可读性上，而不是放到写注释上了！写注释只是提高代码可读性的手段之一，而且写注释也是要讲技巧和效率的。下面将对此进行讨论。

　　二、废话连篇的注释不是好注释！

　　在我看来，优秀的命名规范和代码格式往往比注释更能提高代码可读性。命名规范可以说明代码元素的作用，而代码格式则能使编程思路更清晰——不过很遗憾，它们无论如何都跳不出代码的圈圈，对代码的描述能力并不强，所以我们还是要依靠注释。

　　因此，我们应该先在命名规范和代码格式两个方面严格要求自己，然后再以注释为辅助来描述代码。——请不要怀疑，你读代码的时候是先看代码还是先看注释？一般的情况是，代码能明确说明的问题往往就不需要看注释了，比如上面第一点里写出的那些垃圾注释，没人会把它们当回事的（但被当作入门教程中的示例还不错）。当然，也有例外，以注释为代码主要描述手段的情况在第三点讨论。