很多初学者不愿意写注释，感觉注释没有什么作用，还浪费时间。这种想法是完全错误的。在产品开发过程中，肯定会涉及到人员的更替、硬件的更换和产品技术的升级，如果没有完备的注释，一个新人想又快又好地把旧代码迁移到新的环境下是非常麻烦的事情。很多公司已经注意到这一点，所以对程序员的代码编写往往都有硬性规定：必须写注释，而且必须要按规范书写。本节的规则看上去较繁琐，但是基本不用死记，看一遍即可。

1）一般情况下，源程序有效注释量必须在20%以上。

说明：注释的原则是有助于对程序的阅读理解，在该加的地方都应该加，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。

2）说明性文件（如头文件）头部应进行注释。注释必须列出版权说明、版本号、生成日期、作者、内容、功能、与其他文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

例例，下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

3）源文件头部应进行注释，列出版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。

例如，下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

说明：Description描述本文件的内容、功能、内部各部分之间的关系及本文件与其他文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。

4）函数头部应进行注释，列出函数目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。

例如，下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

5）边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

6）注释的内容要清楚、明了，含义准确，防止注释二义性。(www.daowen.com)

7）避免在注释中使用缩写，特别是不常用的缩写。

说明：在一个文件第一次使用缩写时或之前，应对缩写进行必要的说明。

8）注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如果放于上方则需与其上面的代码用空行隔开。

9）对于具有物理含义的变量、常量，如果其命名不是充分自注释（即见名知意）的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

例如：

或者

10）数据结构声明（包括数组、结构、类、枚举等），如果其命名不是充分自注释的，则必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面。对结构中的每个域的注释放在此域的右方。

11）全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程会使用它以及使用时注意事项等的说明。

12）注释与所描述内容进行同样的缩排。

13）将注释与其上面的代码用空行隔开。

14）对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。