程序代码注释编写规范.docVIP

程序代码注释编写规范 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以//符号开始，任何位于该符号之后的本行文字都视为注释。 多行:以/*符号开始，以*/结束。任何介于这对符号之间的文字都视为注释。 说明性文件 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* ? COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME:??????// 文件 Author:?????? Version:???????? Date: // 作者、版本及完成日期 DESCRIPTION:????// 用于详细说明此程序文件完成的