注释的作用

注释可以帮助其他人阅读程序,通常用于概括算法、确认变量的用途或者阐明难以理解的代码段。注释并不会增加可执行程序的大小,编译器会忽略所有注释。
太多的注释混入程序代码可能会使代码难以理解,通常最好是将一个注释块放在所解释代码的上方。
错误的注释比没有注释更糟,因为它会误导后来者。