编码规范-Java-细则培训教材.ppt

单击此处编辑母版文本样式,Copyright ZTE Corporation 5 July 2005,*,Copyright ZTE Corporation 5 July 2005,1,编码规范-,Java-,细则,培训教程,Java,Copyright ZTE Corporation 5 July 2005,2,目录表,代码布局,基本格式,对齐,空行空格,断行,注 释,命名规则,声明,表达式与语句,类和接口,命名空间,附编程实例,Copyright ZTE Corporation 5 July 2005,3,代码布局,代码布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且会涉及到产品质量，涉及到个人编程能力的提高，必须要引起重视。,Copyright ZTE Corporation 5 July 2005,4,代码布局-基本格式,【规则3-1-1】源代码文件（.,java）,的布局顺序是：包、,import,语句、类。,正例:,package com.zte;,import java.,awt,.peer.,CanvasPeer,;,import java.,io,.File;,import com.zte.ums.,uep,.,AbsPage,;,public class,ClassName,Copyright ZTE Corporation 5 July 2005,5,代码布局-基本格式,【规则3-1-2】遵循统一的布局顺序来书写,import,语句，不同类别的,import,语句之间用空行分隔。,Import,声明必须到具体的对象，不能使用*。,说明：,package,语句其后可跟,import,语句，而且与,package,间隔一个空行。,import,包的排列顺序为,java,开头的包在最前面，接下来是引自外部的包，再接下来是应用程序自身的包，即,import,中标准的包名要在本地的包名之前，而且按照字母顺序排列。,Copyright ZTE Corporation 5 July 2005,6,代码布局-基本格式,【规则3-1-3】,if、else、else if、for、while、do,等语句独占一行，执行语句不得紧跟其后。不论执行语句有多少都要加 。,说明：,这样可以防止书写失误，也易于阅读。,Copyright ZTE Corporation 5 July 2005,7,代码布局-基本格式,建议3-1-1源程序中关系较为紧密的代码应尽可能相邻。,说明：,这样便于程序阅读和查找。,正例,：,length=10;,width=5;/,矩形的长与宽关系较密切，放在一起。,strCaption,=“Test”;,Copyright ZTE Corporation 5 July 2005,8,代码布局-对齐,【规则3-2-1】一般禁止使用制表符，必须使用空格进行缩排。缩进为4个空格。,说明：,对于利用,JBuilder,等编程工具的，可以设置,TAB,键为4个空格代替。消除不同编辑器对制表符处理的差异。,Copyright ZTE Corporation 5 July 2005,9,代码布局-对齐,【规则3-2-2】程序的分界符和应独占一行，同时与引用它们的语句左对齐。之内的代码块使用缩进规则对齐。,说明：,这样使代码便于阅读，并且方便注释。,do while,语句可以例外，,while,条件可与 在同一行。,Copyright ZTE Corporation 5 July 2005,10,代码布局-对齐,【规则3-2-3】多维的数组如果在定义时初始化，按照数组的矩阵结构分行书写。,正例,：,int,number=,1,1,1,2,4,8,3,9,27,4,16,64,;,Copyright ZTE Corporation 5 July 2005,11,代码布局-对齐,【建议3-2-1】相关的赋值语句等号对齐。,正例,：,width=50;,length=20;,height=40;,Copyright ZTE Corporation 5 July 2005,12,代码布局-空行空格,【规则3-3-1】不同逻辑程序块之间要使用空行分隔。,说明：,空行起着分隔程序段落的作用。适当的空行可以使程序的布局更加清晰。,Copyright ZTE Corporation 5 July 2005,13,代码布局-空行空格,【规则3-3-2】一元操作符如“!”、“”、“+”、“-”、“*”、“&”等前后不加空格。“,”、“.”,这类操作符前后不加空格。,正例,：,!,bValue,iValue,+,iCount,&,fSum,aiNumber,i=5;,tBox,.,dWidth,Copyright ZTE Corporation 5 July 2005,14,代码布局-空行空格,【规则3-3-3】多元运算符和它们的操作数之间至少需要一个空格。,正例,：,fValue,=,fOldValue,;,fTotal,+,fValue,iNumber,+=2;,Copyright ZTE Corporation 5 July 2005,15,代码布局-空行空格,【规则3-3-4】方法名之后不要留空格。,说明：,方法名后紧跟左括号(。,Copyright ZTE Corporation 5 July 2005,16,代码布局-空行空格规则3-3-5】(向后紧跟，)、,、;向前紧跟，紧跟处不留空格。,之后要留空格。;不是行结束符号时其后要留空格。,正例：,例子中的,凵,代表空格。,for,(i,凵,=,凵,0;,凵,i,凵,=,”或“,=,”形式。,Copyright ZTE Corporation 5 July 2005,63,表达式与语句5,【规则7-5】在,switch,语句中，每一个,case,分支一般情况下必须使用,break,结尾，如有特殊情况不使用,break，,需要注释说明。最后一个分支必须是,default,分支。,说明：,避免漏掉,break,语句,造成程序错误。有时编程逻辑需要，可以几个,case,语句共用一个语句块，对这种情况必须加注释进行说明。,Copyright ZTE Corporation 5 July 2005,64,表达式与语句6,建议7-1避免在“,if”,条件中赋值。,说明：,Java,编译器对,boolean,型变量在,if,条件语句中的赋值时合法的，对整型变量的赋值是不合法的,。,Copyright ZTE Corporation 5 July 2005,65,表达式与语句7,建议7-2带值的返回语句不需要用括号（）。,说明：,除非有时不得不用括号使返回结构更加明显。,正例：,return;,return,myDisk,.size();,return(size?size:,defaultSize,);/,用括号使返回结构更加明显。,Copyright ZTE Corporation 5 July 2005,66,表达式与语句8,建议,7-3,循环嵌套次数不大于,3,次。,Copyright ZTE Corporation 5 July 2005,67,表达式与语句9,建议7-4,do while,语句和,while,语句仅使用一个条件。,说明：,保持程序简洁。如果需要判断的条件较多，建议用临时布尔变量先计算是否满足条件,Copyright ZTE Corporation 5 July 2005,68,表达式与语句,10,建议,7-5,在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环放在最外层，以减少,CPU,跨切循环层的次数。,Copyright ZTE Corporation 5 July 2005,69,表达式与语句,11,建议,7-6,不可在,for,循环体内修改循环变量，防止,for,循环失去控制。,Copyright ZTE Corporation 5 July 2005,70,表达式与语句12,建议7-5,for,语句的循环控制变量的取值采用“半开半闭区间”写法。,正例：,int arrintScore,NUM;,for(i=0;i NUM;i+),printf,(“%dn”,arrintScore,i),Copyright ZTE Corporation 5 July 2005,71,类和接口1,【规则,8-1,】类内部的代码布局顺序：类变量、属性、构造函数、方法。,Copyright ZTE Corporation 5 July 2005,72,类和接口2,建议,8-1,功能相关的方法放在一起。,Copyright ZTE Corporation 5 July 2005,73,类和接口3,建议8-2函数的参数个数不宜超过4个。,说明：,过多的函数参数会导致性能降低。,Copyright ZTE Corporation 5 July 2005,74,类和接口4,建议8-3使程序结构体现程序的目的。,正例,：,return,booleanExpression,;,Copyright ZTE Corporation 5 July 2005,75,类和接口5,建议,8-4,保证内部类定义成,private,，,提高类的封装性。,Copyright ZTE Corporation 5 July 2005,76,类和接口6,建议,8-5,嵌套内部类不能超过两层。,Copyright ZTE Corporation 5 July 2005,77,类和接口7,建议,8-6,一个接口可以有多个实现类，实现类共同的变量在接口里声明。,Copyright ZTE Corporation 5 July 2005,78,附编程实例,见,word,文档,Copyright ZTE Corporation 5 July 2005,79,谢 谢,Copyright ZTE Corporation 5 July 2005,80,