- 1、本文档共15页,可阅读全部内容。
- 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
C语言代码编写规范
C 语言编码规范
编程规范
C 语言
USTB Roboteam
Create Date:2007-01
Version: 2.10bate
USTB ROBOTEAM
C 语言编码规范
编码格式
I. 注释
注释是源码程序中非常重要的一部分,一般情况下,源程序有效注释量必须在15%以上。
注释的原则是有助于对程序的阅读理解,所以注释语言必须准确、易懂、简洁。注释不宜太多
也不能太少,注释的内容要清楚、明了,含义准确,防止注释二义性,该加的地方一定要加,但不
必要的地方一定不要加。
(1)模块(C文件)描述
模块描述中应该包括。版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志
等。 例如:
/***********************************************************
Module Name: //模块的名字
Module Date: //生成日期
Module Auth: //作者名字
Description: // 用于详细说明此程序文件完成的主要功能,与其他模块
// 或函数的接口,输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
Revision History:
Date Rel Ver. Notes
月/日/年 x.x //所进行的修改
***********************************************************/
/*Includes*/
//包含的头文件
/*Local Variables */
//定义一些本地变量
/*Local Structures and Typedefs */
//要使用的一些数据结构
/*Extern Variables */
USTB ROBOTEAM
C 语言编码规范
//使用到的一些外部变量
/*Definitions*/
//一些#defines及具体的函数实现
(2)头文件描述
头文件一般包括了数据结构的定义,函数原形的说明,宏定义等,不许包含函数体和变量实体,
文件名使用缺省的后缀 .h ,头文件的
文档评论(0)