comment

作为最有用和最少用的编程习惯中的一个，注释是附加在源代码上提供说明信息的附注，通常说明了代码的功能。注释通常对维护和改进你的代码的人非常有用，注释同样可以为和你合作开发的人增进代码的完整性和可读性。　　

为了使编译器认出注释，并不致与指令混淆，特殊的字符（如“#“、”/*“、”'“和”//“）被用来标记注释的开始与结尾。HTML注释的开始字符为（"）；在注释范围内的字符是可见的，也就是说任何人可以读这些代码。在Web浏览器中阅读此页面，例如，你可以选择“查看”，然后选择“查看源代码”来查看一个页面的包含注释的HTML代码。　　

一个程序至少应该包括：描述文件内容的文件注释块，以便余毒文件的人能够不读代码就可以了解它；另一个是描述每个函数代码功能的函数注释块。另外，一些程序员为每个语言声明提供一个注释。