程序代码注释编写规范

时间:2022-07-15 13:15:12 阅读: 最新文章 文档下载
说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。
百度文库 - 让每个人平等地提升自我

程序代码注释编写规范

为提高控制程序的阅读性与可理解性,现制定相关代码程序代码注释编写的编写规范。 一般情况下,源程序有效注释量必须在20%以上,注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。

单行:"文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。

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

/************************************************* (C), MicTiVo International. Co., Ltd. 1. File : .

History: Date: Author:

Modification: 2. ..

*************************************************/ 一、源文件头

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

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

/************************************************************ (C), MicTiVo International. Co., Ltd. FileName: Author: Version : Date: : /

}







/* receive _process() */ :与溢出中断写初值不同

1


本文来源:https://www.wddqw.com/doc/107d1b17988fcc22bcd126fff705cc1754275f0d.html