虽然注释是很好的,但是过多的注释也是有危险的,不要试图去解释你的代码注释是如何的好。你应该将代码写得更好,而不是花费大量时间去解释那些糟糕的代码。
在通常情况下,注释应说明代码做些什么,而不是怎么做的。而且,要避免将注释插在一个函数体里。假如这个函数确实很复杂,你需要在其中进行注释。那么我们可以写一些简短的注释来说明程序部分,但是要言简意赅。取而代之的是,可将注释写在函数前告诉别人它做些什么事情和为什么要这样做。