欢迎来到天天文库
浏览记录
ID:40407062
大小:359.27 KB
页数:18页
时间:2019-08-01
《p2C语言程序代码编写规范》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、C语言程序代码编写规范(初级程序员版)前言一个好的程序编写规范是编写高质量程序的保证。清晰、规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性。目录内容代码书写规范注释书写规范命名规范1代码书写规范1.1函数定义每个函数的定义和说明应该从第1列开始书写。函数名(包括参数表)和函数体的花括号(“{”和“}”)应该各占一行。在函数体结尾的括号(“}”)后面应该加上注释,注释中应该包括函数名,这样比较方便进行括号配对检查,也可以清晰地看出来函数是否结束。范例1:
2、函数的声明voidmatMyFunction(intn){……}/*matMyFunction*/1.2空格的使用使用空格分割所有演算符号和操作数。这条规则的例外是“->”,“.”,“()”和“[]”,这些操作符和操作数之间不空格。当需要把一个程序行的内容分成几行写时,操作符号应该放在行末,而不是下一行的开头。1.3缩进的设置代码书写应该遵从结构化的要求,采用缩进的格式。最小缩进量为4个空格,整个文件内部应该统一,不要混用Tab键和4个空格这两种情况,因为不同的编辑器对Tab键的处理方法不同。1.4折行的使用
3、每行的长度不要超过80个字符,当程序行太长时,应该分行书写。分行时应该按照自然的逻辑关系进行,例如:不要把一个简单的逻辑判断写在两行上。分行后的缩进应该按照程序的逻辑关系进行对齐。例如:参数表折行后,下面的行应该在参数表左括号的下方。范例2:折行的格式dwNewShape=matAffineTransform(coords,translation,rotation);if(((new_shape.x>left_border)&&(new_shape.x4、y>bottom_border)&&(new_shape.y5、e);}}else{error("Thevalueistoobig.");}/*if(value6、******************************************强调注释**************************************************//**块注释*//*单行注释*/inti;/*行末注释*/如果变量的名字不能完全说明其用途,应该使用注释加以说明。如果为了提高性能而使某些代码变得难懂,应该使用注释加以说明。对于一个比较长的程序段落,应该加注释予以说明。如果设计文档中有流程图,则程序中对应的位置应该加注释予以说明。如果程序中使用了某个复杂的算法,建议注7、明其出处。如果在调试中发现某段落容易出现错误,应该注明。2.2何时需要注释3命名规范3.1常量、变量命名用#define定义的符号常量全部采用大写。变量命名的基本原则:可以选择有意义的英文(小写字母)组成变量名,使人看到该变量就能大致清楚其含义。不要使用人名、地名和汉语拼音。如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。多个单词组成的变量名,每个单词的首字母应该大写。如:dwUserInputValue。函数命名原则与变量命名原则基本相同。对于初学者,函数命名可以采用“FunctionName”的形8、式。3.2函数命名参考资料C/C++编程风格指南,李海代码风格规范,翟志刚
4、y>bottom_border)&&(new_shape.y5、e);}}else{error("Thevalueistoobig.");}/*if(value6、******************************************强调注释**************************************************//**块注释*//*单行注释*/inti;/*行末注释*/如果变量的名字不能完全说明其用途,应该使用注释加以说明。如果为了提高性能而使某些代码变得难懂,应该使用注释加以说明。对于一个比较长的程序段落,应该加注释予以说明。如果设计文档中有流程图,则程序中对应的位置应该加注释予以说明。如果程序中使用了某个复杂的算法,建议注7、明其出处。如果在调试中发现某段落容易出现错误,应该注明。2.2何时需要注释3命名规范3.1常量、变量命名用#define定义的符号常量全部采用大写。变量命名的基本原则:可以选择有意义的英文(小写字母)组成变量名,使人看到该变量就能大致清楚其含义。不要使用人名、地名和汉语拼音。如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。多个单词组成的变量名,每个单词的首字母应该大写。如:dwUserInputValue。函数命名原则与变量命名原则基本相同。对于初学者,函数命名可以采用“FunctionName”的形8、式。3.2函数命名参考资料C/C++编程风格指南,李海代码风格规范,翟志刚
5、e);}}else{error("Thevalueistoobig.");}/*if(value6、******************************************强调注释**************************************************//**块注释*//*单行注释*/inti;/*行末注释*/如果变量的名字不能完全说明其用途,应该使用注释加以说明。如果为了提高性能而使某些代码变得难懂,应该使用注释加以说明。对于一个比较长的程序段落,应该加注释予以说明。如果设计文档中有流程图,则程序中对应的位置应该加注释予以说明。如果程序中使用了某个复杂的算法,建议注7、明其出处。如果在调试中发现某段落容易出现错误,应该注明。2.2何时需要注释3命名规范3.1常量、变量命名用#define定义的符号常量全部采用大写。变量命名的基本原则:可以选择有意义的英文(小写字母)组成变量名,使人看到该变量就能大致清楚其含义。不要使用人名、地名和汉语拼音。如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。多个单词组成的变量名,每个单词的首字母应该大写。如:dwUserInputValue。函数命名原则与变量命名原则基本相同。对于初学者,函数命名可以采用“FunctionName”的形8、式。3.2函数命名参考资料C/C++编程风格指南,李海代码风格规范,翟志刚
6、******************************************强调注释**************************************************//**块注释*//*单行注释*/inti;/*行末注释*/如果变量的名字不能完全说明其用途,应该使用注释加以说明。如果为了提高性能而使某些代码变得难懂,应该使用注释加以说明。对于一个比较长的程序段落,应该加注释予以说明。如果设计文档中有流程图,则程序中对应的位置应该加注释予以说明。如果程序中使用了某个复杂的算法,建议注
7、明其出处。如果在调试中发现某段落容易出现错误,应该注明。2.2何时需要注释3命名规范3.1常量、变量命名用#define定义的符号常量全部采用大写。变量命名的基本原则:可以选择有意义的英文(小写字母)组成变量名,使人看到该变量就能大致清楚其含义。不要使用人名、地名和汉语拼音。如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。多个单词组成的变量名,每个单词的首字母应该大写。如:dwUserInputValue。函数命名原则与变量命名原则基本相同。对于初学者,函数命名可以采用“FunctionName”的形
8、式。3.2函数命名参考资料C/C++编程风格指南,李海代码风格规范,翟志刚
此文档下载收益归作者所有