C代码编写规范

C代码编写规范

ID:37720641

大小:91.88 KB

页数:11页

时间:2019-05-29

C代码编写规范_第1页
C代码编写规范_第2页
C代码编写规范_第3页
C代码编写规范_第4页
C代码编写规范_第5页
资源描述:

《C代码编写规范》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库

1、C编程规范1布局与风格总体目标:准确表现代码的逻辑结构;改善可读性;经的起修改。1.总体布局采用纯块布局,即“{”“}”垂直对齐;intfunc(intx,inty,intz)(√){...return0;}intfunc(intx,inty,intz){(×)...return0;}缩进Tab为4字节对于复杂表达式,将条件分格在几行上一行代码宽度应不超过80个字符,对于较长的语句,应该分行书写,增加代码的可读性。不要将赋值语句按等号对齐;if(p!=NULL)(√)deletep;if(p!=NULL)deletep;(×)每行仅写一条语句if(p!=NULL)(√)dele

2、tep;if(p!=NULL)deletep;(×)每行仅写一条语句1.空格l需要有空格的地方双目运算符两侧,需要留有空格。如“=”,“+=”,“>=”,“<=”,“+”,“&&”,“<<”,“^”等。x+=y;(√)x+=y;(×)val=(mask<<3)(√)val=(mask<<3);(×)函数参数之间逗号‘,’分隔后面要留有空格。voidfunc(intx,inty,intz)(√)voidfunc(intx,inty,intz)(×)for语句分号‘;’分隔后面要留有空格for(i=0;i<10;i++)(√)for(i=0;i<10;i++)(×)l不要留空格的地

3、方函数名与紧跟的左括号‘(’之间,不应有空格voidfunc(intx,inty,intz)(√)voidfunc(intx,inty,intz)(×)左括号的右边,以及右括号的左边,不要有空格if(x==y)(√)if(x==y)(×)一目运算符前后不加空格,如’!’,’~’,’++’,‘&’(取地址符)等。i++;char*p=&tmp;}<-空行‘[]’,‘->’,’.’操作符前后不加空格tmp=p->size;(√)tmp=p->size;(×)limit=packet.size;(√)limit=packet.size;(×)x=array[2];(√)x=array

4、[2];(×)x=array[2];(×)对于表达式较长的语句,应适当的去掉一些空格,以保证代码的紧凑性if((x>=100)

5、

6、((x<50)&&(y!=0)))(√)if(i=0;i<100;i++)(√)if(i=0;i<100;i++)(×)1.空行函数定义的前后,均需要适当的空行。<-空行voidfunc1(intx){...}<-空行voidfunc2(void){...}<-空行在函数体内,在一组变量定义完之后,需要适当空行。voidfunc(void*p){intx=0;void*tmp=NULL;<-空行if(p!=NULL){...}}2.注释布局a)注释的

7、缩进要与相应代码一致;3.子程序布局a)用空行分隔子程序的头、数据、常量声明以及子程序体之间。b)函数参数布局顺序,输入参数、输入输出参数、输出参数、默认参数。1.文件布局a)源文件(.c)b)头文件(.h);c)文件的命名与实现的功能相关1注释总体目标:注释易于维护、清晰明了,不要随意添加无关注释。1.行尾注释a)行尾注释必须简短;b)数据声明用行尾注释;c)用行尾注释标记块,如while,if,#endif等,特别是代码块很大时;2.代码段注释a)要表达代码段意图;b)注重“为何做”(why)而不是“怎么做”(how);c)让每个注释都有用;d)说明非常规做法;e)不用缩略

8、语;f)将主次注释区分开;g)对错误或语言环境独特点加注释;3.数据声明注释a)注释数值单位;b)对数值的取值范围注释;c)注释编码含义;如1代表直流电,2代表交流电,3未确定;d)注释对输入数据的限制;e)注释全局数据;4.子程序注释a)分清输入和输出数据;/*!函数说明@paramaText[in/out]参数说明主要用于函式说明中,@paramaPos[in]只是输入@return返回值后面接函数传回值的说明。用于function的批注中。*/voidDrawText(char*aText,TPointaPos);b)对局限性作注释;c)注释算法来源;d)说明子程序的全局

9、效果;5.文件注释a)说明文件的意图和内容;b)将名字、电子邮件或电话放到注释块中;c)包含版本信息;d)包含法律通告;/*--------------------------------------------------------@file文件名称@ingroup公司名称或者工作组@author作者@date最后版本时间@brief这里是说明,比如功能和注意的地方等等history创建时间(C)Copyright1993-2004StevenC.McConnell.AllRightsR

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。