欢迎来到天天文库
浏览记录
ID:37970313
大小:45.50 KB
页数:5页
时间:2019-06-04
《C语言学习必读之程序书写规范篇 newstcw乐分享-快导航》由会员上传分享,免费在线阅读,更多相关内容在应用文档-天天文库。
1、C语言程序代码编写规范(初级程序员讨论版)前言一个好的程序编写规范是编写高质量程序的保证。清晰、规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性。说明l本文档主要适用于刚刚开始接触编程的初学者。bbs.newstcw.com-乐分享-快导航l对于具有一定工程项目开发经验的程序员,建议学习C语言程序代码编写规范—高级版。目录1代码书写规范2注释书写规范3命名规范4其它一些小技巧和要求1代码书写规范1.1函数定义花括号: { }每个函数的定义和说明应该
2、从第1列开始书写。函数名(包括参数表)和函数体的花括号应该各占一行。在函数体结尾的括号后面可以加上注释,注释中应该包括函数名,这样比较方便进行括号配对检查,也可以清晰地看出来函数是否结束。范例1:函数的声明voidmatMyFunction(intn){……}/*matMyFunction*/1.2空格与空行的使用bbs.newstcw.com-乐分享-快导航要加空格的场合l在逗号后面和语句中间的分号后面加空格,如:inti,j,k;for(i=0;i3、各留一个空格,如a>b a<=b i=0l关键字两侧,如if()…,不要写成if()…l类型与指针说明符之间一定要加空格:char*szName;不加空格的场合l在结构成员引用符号.和->左右两加不加空格:pStud->szName, Student.nIDl不在行尾添加空格或Tabl函数名与左括号之间不加空格:func(…)l指针说明符号*与变量名间不要加空格:int*pInt;不要写成:int*pInt;l复合运算符中间不能加空格,否则会产生语法错误,如:a+=b a<=b 都是错误的空行与换行l函数的变4、量说明与执行语句之间加上空行;l每个函数内的主要功能块之间加空行表示区隔;l不要在一行中写多条语句.范例2:空行与换行bbs.newstcw.com-乐分享-快导航intmain(){ inti,j,nSum=0; //变量说明 for(i=0;i<10;i++) //执行代码 {for(j=0;j<10;j++){ nSum+=i;} }}1.3缩进的设置根据语句间的层次关系采用缩进格式书写程序,每进一层,往后缩进一层有两种缩进方式:1,使用Tab键;2,采用4个空格。bbs.newstcw.com5、-乐分享-快导航整个文件内部应该统一,不要混用Tab键和4个空格,因为不同的编辑器对Tab键的处理方法不同。1.4折行的使用bbs.newstcw.com-乐分享-快导航·每行的长度不要超过80个字符,当程序行太长时,应该分行书写。·当需要把一个程序行的内容分成几行写时,操作符号应该放在行末。·分行时应该按照自然的逻辑关系进行,例如:不要把一个简单的逻辑判断写在两行上。·分行后的缩进应该按照程序的逻辑关系进行对齐。例如:参数表折行后,下面的行应该在参数表左括号的下方。范例2:折行的格式dwNewShape=matAffin6、eTransform(coords,translation, rotation);if(((new_shape.x>left_border)&&(new_shape.xbottom_border)&&(new_shape.y7、花括号的左括号应该单独占一行,并与关键字对齐。建议即使语句块中只有一条语句,也应该使用花括号包括,这样可以使程序结构更清晰,也可以避免出错。建议对比较长的块,在末尾的花括号后加上注释以表明该语言块结束。范例3:嵌套语句格式if(value8、要适中,过多或过少都易导致阅读困难。2.1注释风格bbs.newstcw.com-乐分享-快导航·C语言中使用一组(/*…*/)作为注释界定符。·注释内容尽量用英语方式表述。·注释的基本样式参考范例4。·注释应该出现在要说明的内容之前,而不应该出现在其后。·除了说明变量的用途和语言块末尾使用的注释,尽量
3、各留一个空格,如a>b a<=b i=0l关键字两侧,如if()…,不要写成if()…l类型与指针说明符之间一定要加空格:char*szName;不加空格的场合l在结构成员引用符号.和->左右两加不加空格:pStud->szName, Student.nIDl不在行尾添加空格或Tabl函数名与左括号之间不加空格:func(…)l指针说明符号*与变量名间不要加空格:int*pInt;不要写成:int*pInt;l复合运算符中间不能加空格,否则会产生语法错误,如:a+=b a<=b 都是错误的空行与换行l函数的变
4、量说明与执行语句之间加上空行;l每个函数内的主要功能块之间加空行表示区隔;l不要在一行中写多条语句.范例2:空行与换行bbs.newstcw.com-乐分享-快导航intmain(){ inti,j,nSum=0; //变量说明 for(i=0;i<10;i++) //执行代码 {for(j=0;j<10;j++){ nSum+=i;} }}1.3缩进的设置根据语句间的层次关系采用缩进格式书写程序,每进一层,往后缩进一层有两种缩进方式:1,使用Tab键;2,采用4个空格。bbs.newstcw.com
5、-乐分享-快导航整个文件内部应该统一,不要混用Tab键和4个空格,因为不同的编辑器对Tab键的处理方法不同。1.4折行的使用bbs.newstcw.com-乐分享-快导航·每行的长度不要超过80个字符,当程序行太长时,应该分行书写。·当需要把一个程序行的内容分成几行写时,操作符号应该放在行末。·分行时应该按照自然的逻辑关系进行,例如:不要把一个简单的逻辑判断写在两行上。·分行后的缩进应该按照程序的逻辑关系进行对齐。例如:参数表折行后,下面的行应该在参数表左括号的下方。范例2:折行的格式dwNewShape=matAffin
6、eTransform(coords,translation, rotation);if(((new_shape.x>left_border)&&(new_shape.xbottom_border)&&(new_shape.y7、花括号的左括号应该单独占一行,并与关键字对齐。建议即使语句块中只有一条语句,也应该使用花括号包括,这样可以使程序结构更清晰,也可以避免出错。建议对比较长的块,在末尾的花括号后加上注释以表明该语言块结束。范例3:嵌套语句格式if(value8、要适中,过多或过少都易导致阅读困难。2.1注释风格bbs.newstcw.com-乐分享-快导航·C语言中使用一组(/*…*/)作为注释界定符。·注释内容尽量用英语方式表述。·注释的基本样式参考范例4。·注释应该出现在要说明的内容之前,而不应该出现在其后。·除了说明变量的用途和语言块末尾使用的注释,尽量
7、花括号的左括号应该单独占一行,并与关键字对齐。建议即使语句块中只有一条语句,也应该使用花括号包括,这样可以使程序结构更清晰,也可以避免出错。建议对比较长的块,在末尾的花括号后加上注释以表明该语言块结束。范例3:嵌套语句格式if(value8、要适中,过多或过少都易导致阅读困难。2.1注释风格bbs.newstcw.com-乐分享-快导航·C语言中使用一组(/*…*/)作为注释界定符。·注释内容尽量用英语方式表述。·注释的基本样式参考范例4。·注释应该出现在要说明的内容之前,而不应该出现在其后。·除了说明变量的用途和语言块末尾使用的注释,尽量
8、要适中,过多或过少都易导致阅读困难。2.1注释风格bbs.newstcw.com-乐分享-快导航·C语言中使用一组(/*…*/)作为注释界定符。·注释内容尽量用英语方式表述。·注释的基本样式参考范例4。·注释应该出现在要说明的内容之前,而不应该出现在其后。·除了说明变量的用途和语言块末尾使用的注释,尽量
此文档下载收益归作者所有