C语言编程规范.docx
- 文档编号:959387
- 上传时间:2022-10-14
- 格式:DOCX
- 页数:45
- 大小:46.35KB
C语言编程规范.docx
《C语言编程规范.docx》由会员分享,可在线阅读,更多相关《C语言编程规范.docx(45页珍藏版)》请在冰豆网上搜索。
C语言编程规范
嵌入工软件——C语言编程规范
1排版
1.1严格采用阶梯层次组织程序代码
函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。
程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
各层次缩进的风格采用TAB缩进(TAB宽度原则上使用系统默认值,建议:
Eclipse中使用6空格宽度)。
示例:
if(xistrue)
{
wedoy
}
else
{
if(a>b)
{
...
}
else
{
...
}
}
和:
if(x==y)
{
...
}
elseif(x>y)
{
...
}
else
{
....
}
注意,右括号所在的行不应当有其它东西,除非跟随着一个条件判断。
也就是do-while语句中的“while”,象这样:
do
{
bodyofdo-loop
}while(condition);
1.2及时折行
较长的语句(>120字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进(至少1个TAB位置),使排版整齐,语句可读。
示例:
report_or_not_flag=((taskno &&(n7stat_stat_item_valid(stat_item)) &&(act_task_table[taskno].result_data! =0)); 循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。 示例: if((taskno &&(n7stat_stat_item_valid(stat_item))) { ...//programcode } for(i=0,j=0;(i &&(j { ...//programcode } for(i=0,j=0; (i i++,j++) { ...//programcode } 若函数或过程中的参数较长,则要进行适当的划分。 示例: n7stat_str_compare((BYTE*)&stat_object, (BYTE*)&(act_task_table[taskno].stat_object), sizeof(_STAT_OBJECT)); n7stat_flash_act_duration(stat_item,frame_id*STAT_TASK_CHECK_NUMBER +index,stat_object); 1.3一行只写一条语句 不允许把多个短语句写在一行中,即一行只写一条语句。 示例,如下例子不符合规范: rect.length=0;rect.width=0; 应如下书写 rect.length=0; rect.width=0; 1.4if、for、do、while等语句格式规定 if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加花括号{}。 1.5空行 (1)变量说明之后必须加空行。 (2)相对独立的程序块之间应加空行。 1.6空格 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。 采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。 给操作符留空格时不要连续留两个以上空格。 (1)逗号、分号只在后面加空格。 inta,b,c; (2)比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。 if(current_time>=MAX_TIME_VALUE) { a=b+c; } a*=2; a=b^2; (3)"! "、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。 *p='a';//内容操作"*"与内容之间 flag=! isEmpty;//非操作"! "与内容之间 p=&mem;//地址操作"&"与内容之间 i++;//"++","--"与内容之间 (4)"->"、"."前后不加空格。 p->id=pid;//"->"指针前后不加空格 (5)if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。 if(a>=b&&c>d) 1.7对变量的定义,尽量位于函数的开始位置 (1)应避免分散定义变量。 (2)同一行内不要定义过多变量。 (3)同一类的变量在同一行内定义,或者在相邻行定义。 (4)数组、指针等复杂类型的定义放在定义区的最后。 (5)变量定义区不做较复杂的变量赋值。 1.8程序各部分的放置顺序 在较小的项目中,按如下顺序组织安排程序各部分: (1)#include (2)#include〞用户自定义的文件〞。 (3)#define宏定义。 (4)全局变量定义。 (5)函数原型声明。 (6)main函数定义。 (7)用户自定义函数。 以上各部分之间、用户自定义的函数之间应加空行。 注意,函数原型声明统一集中放在main函数之前,不放在某个函数内部。 2注释 2.1注释的原则和目的 注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的——清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释——过量的注释则是有害的。 注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。 示例: 如下注释意义不大。 /*ifreceive_flagisTRUE*/ if(receive_flag) 而如下的注释则给出了额外有用的信息。 /*ifmtpreceiveamessagefromlinks*/ if(receive_flag) 2.2说明性文件头部应进行注释 说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出: 版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 示例: 下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /** *Copyright(C),1988-1999,HuaweiTech.Co.,Ltd. *Filename: //文件名 *Author: Version: Date: //作者、版本及完成日期 *Description: //用于详细说明此程序文件完成的主要功能,与其他模块 //或函数的接口,输出值、取值范围、含义及参数间的控 //制、顺序、独立或依赖等关系 *Others: //其它内容的说明 *FunctionList: //主要函数列表,每条记录应包括函数名及功能简要说明 1..... *History: //修改历史记录列表,每条修改记录应包括修改日期、修改 //者及修改内容简述 1.Date: Author: Modification: 2.... */ 2.3源文件头部应进行注释 源文件头部应进行注释,列出: 版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例: 下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /** *Copyright(C),1988-1999,HuaweiTech.Co.,Ltd. *FileName: test.cpp *Author: Version: Date: *Description: //模块描述 *Version: //版本信息 *FunctionList: //主要函数及其功能 1.------- *History: //历史修改记录 David96/10/121.0buildthismoudle */ 说明: Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。 History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。 2.4函数头部应进行注释 函数头部应进行注释,列出: 函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 示例1: 下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /** *Function: //函数名称 *Description: //函数功能、性能等的描述 *Calls: //被本函数调用的函数清单 *CalledBy: //调用本函数的函数清单 *TableAccessed: //被访问的表(此项仅对于牵扯到数据库操作的程序) *TableUpdated: //被修改的表(此项仅对于牵扯到数据库操作的程序) *Input: //输入参数说明,包括每个参数的作 //用、取值说明及参数间关系。 *Output: //对输出参数的说明。 *Return: //函数返回值的说明 *Others: //其它说明 */ 对于某些函数,其部分参数为传入值,而部分参数为传出值,所以对参数要详细说明该参数是入口参数,还是出口参数,对于某些意义不明确的参数还要做详细说明(例如: 以角度作为参数时,要说明该角度参数是以弧度(PI),还是以度为单位),对既是入口又是出口的变量应该在入口和出口处同时标明。 等等。 在注释中详细注明函数的
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 语言 编程 规范