关于程序注释的基础知识

关于程序注释的基础知识

作者：陈跃峰

出自：http://blog.csdn.net/mailbomb

 

       程序注释是书写规范程序时很重要的一个内容，下面是关于注释的一些说明：

l         注释的作用：方便代码的阅读和维护（修改）。

l         注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不会增加可执行文件的大小。

l         注释可以书写在代码中的任意位置，但是一般写在代码的开发或者结束位置。

l         修改程序代码时，一定要同时修改相关的注释，保持代码和注释的同步。

l         在实际的代码规范中，要求注释占程序代码的比例达到20%左右，即100行程序中包含20行左右的注释。