资源描述：
《对c语言编码规范的探讨》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。
1、山西电子技术研究与探讨2011年第1期文章编号:16744578(2011)01007702对C语言编码规范的探讨刘竹林(十堰职业技术学院电子工程系,湖北十堰442000)摘要:对大多数利用C语言编写软件代码的工程师而言,存在的突出问题是软件代码编写不规范,导致程序的可读性和可维护性差。为了保证在软件开发过程中,前后的代码风格一致,便于维护,提高软件产品的质量和保持开发产品的延续性,尝试制定本编码规范。本规范详细制定了源代码书写、变量命名、函数/过程的书写、错误和异常处理等方法。关键词:C语言;软件代码;编码规范
2、中图分类号:TP301文献标识码:A0引言空行。(2)在一个函数体内,逻辑上密切相关的语句之间不加在软件开发过程中,代码的质量直接影响软件产品的质空行,其它地方应加空行分隔。量。一个合格的软件工程师的任务就是要在预定的时间和1.4代码行进度下交付高质量的软件产品。现在,软件系统的规模越来(1)一行代码只做一件事情,如只定义一个变量,或只越大,复杂程度越来越高,软件的质量也越来越重要。由于写一条语句。这样的代码容易阅读,并且便于写注释。如不软件开发是一个思考过程,开发人员的编程习惯和思维方式好的风格:intwidth,h
3、eight,depth;//宽度高度深度。直接影响到软件产品的质量。所以在20世纪60年代才会(2)if、for、while、do等语句自占一行,执行语句不得紧爆发软件危机。而且人们也渐渐认识到,在软件开发过程跟其后。不论执行语句有多少都要加{}。这样可以防止书中,编码不规范的积累与放大效应是导致软件危机最主要的写失误。原因。本文尝试对C语言编码规范做了个探讨。1.5对齐1排版(1)程序的分界符{和}应独占一行并且位于同一版式虽然不会影响程序的功能,但会影响可读性。程序列,同时与引用它们的语句左对齐。的版式追求清晰
4、、美观,是程序风格的重要构成因素。可以(2){}之内的代码块在{右边数格处左对齐。把程序的版式比喻为书法。好的书法可让人对程序一1.6长行拆分目了然,看得兴致勃勃。差的程序书法如螃蟹爬行,让人长表达式要在低优先级操作符处拆分成新行,操作符放看得索然无味,更令维护者烦恼有加。在新行之首(以便突出操作符)。拆分出的新行要进行适当1.1缩进的缩进,使排版整齐,语句可读。程序块采用缩进风格编写,缩进为4个空格位。排版不2注释混合使用空格和TAB键。注释的原则是有助于对程序的阅读理解,注释不宜太多1.2空格也不能
5、太少,太少不利于代码理解,太多则会对阅读产生干(1)函数名之后不要留空格,紧跟左括号(。扰,因此只在必要的地方才加注释,而且注释要准确、易懂、(2)(向后紧跟,)、,、;向前紧跟,紧跟处不尽可能简洁。注释量一般控制在30%到50%之间。留空格。(1)一般情况下,源程序有效注释量必须在20%以上。(3),之后要留空格,如Function(intx,inty,intz)。注释是对代码的提示,而不是文档。程序中的注释不可如果;不是一行的结束符号,其后要留空格,如for(initial喧宾夺主,注释太
6、多了会让人眼花缭乱。注释的花样要少。ization;condition;update)。(2)头文件、源文件的头部,应进行注释。注释必须列(4)一元操作符如!、~、++、&(地址运算出:文件名、作者、目的、功能、修改日志等。符)等前后不加空格。(3)函数头部应进行注释,列出:函数的目的、功能、输(5)赋值操作符、比较操作符、算术操作符、逻辑操作入参数、输出参数、修改日志等。符、位域操作符,如=、+=>=、<=、+、(4)程序在必要的地方必须有注释,注释要准确、易懂、*、%、&&、
7、、<<,^等二元操作符的前后简洁。如果代码本来就是清楚的,则不必加注释。应当加空格。(5)注释的位置应与被描述的代码相邻,可以放在代码(6)象[]、.、->这类操作符前后不加空格。的上方或右方,不可放在下方,也不可放在代码的中间,如放1.3空行在代码上方则注释需与其上面的代码用空行隔开。(1)在每个类声明之后、每个函数定义结束之后都要加(6)边写代码边注释,修改代码同时修改相应的注释,收稿日期:2010-09-13作者简介:刘竹林(1980),男,湖北十堰人,讲师,研究方向:嵌入式技术及应用。78山
8、西电子技术2011年以保证注释与代码的一致性。不再有用的注释要删除。(3)不要使用难懂的技巧性很高的语句,除非很有必要(7)注释与所描述内容进行同样的缩排。时。(高技巧语句不等于高效率的程序,实际上程序的效率(8)注释应当准确、易懂,防止
