《JAVA编码规范(开发培训讲义)PPT幻灯片》由会员分享，可在线阅读，更多相关《JAVA编码规范(开发培训讲义)PPT幻灯片（70页珍藏版）》请在金锄头文库上搜索。
1、1,Lishoulin,PTC,普联软件(中国)有限公司 2011年度入职培训，济南燕山学院,PANSOFT,JULY,2011,编码规范(JAVA版),JAVA之路JAVA开发人员编码规范,Technology Team Progress,2,编码规范的必要性,你自己|编码规范对于程序员自己而言尤为重要 其它人|几乎没有一个软件，在其整个生命周期中，均由最初的开发人员来维护 ，其它的人能看懂你的代码吗? 生命周期|80%的花费在于维护 可读性|编码规范可以改善软件的可读性 代码理解|有助于尽快而彻底地理解新的代码 团队协作|必不可少的规范 正确率|保证正确率，规避低级的错误,PANFOT J
2、AVA Developer,3,规范的实施,原则|参照规范|注重实践|从点滴做起 范围|全体使用JAVA开发的编码人员|设计人员 时机|开发软件项目|产品的任何时间 检查|项目组内部检查|公司专门人员抽查 修改或升级|专门小组负责,PANFOT JAVA Developer,4,主要内容,JAVA代码编写规范 数据库访问规范 操作界面设计规范 常用工具,PANFOT JAVA Developer,5,JAVA代码编写规范,PANFOT JAVA Developer,6,文件组织,文件名|java|class 文件组织|单个源文件长度控制在2000行,PANFOT JAVA Developer,
3、7,包与类、接口命名,包|全部小写,com+公司名+产品名+模块名 类|名词|大小写混合|简洁而完整|首字符使用J或者T 接口|大小写混合|简洁而完整|首字符使用I,PANFOT JAVA Developer,com.pansoft.finance com.pansoft.public class JRaster;class JImageSprite interface IRasterDelegate;interface IStoring;,8,方法命名,方法|动词|大小写混合|首字母小写|其后单词首字母大写,PANFOT JAVA Developer,run();runFast();getB
4、ackground();,9,变量命名,大小写混合|首字母小写|后面单词首字母大写 不应使用下划线 名称应简短而富描述性|便于记忆 避免单字母变量名,除非| 临时变量 i|j|k|m|n一般用于整型临时变量 c|d|e一般用于字符型临时变量,PANFOT JAVA Developer,char c;int i;float myWidth;,10,成员变量,和变量名相似 前面加m,PANFOT JAVA Developer,int mEmployeeId;String mName;Customer mCustomer;,11,实参变量,大小写规则和变量名相似 前面需要加一个p,PANFOT JA
5、VA Developer,public void callMe(int pAge, String pName) ,12,常量,全部大写 单词间用下划线隔开,PANFOT JAVA Developer,static final int MIN_WIDTH = 4;static final int MAX_WIDTH = 999;static final int GET_THE_CPU = 1;,13,开头注释,开头有一个C语言风格的注释 列出类名|版本信息|日期|版权,PANFOT JAVA Developer,/* * Classname * * Version information * *
6、 Date * * Copyright notice */,14,包和引入语句,第一个非注释行是包语句 之后可以跟引入语句,PANFOT JAVA Developer,package java.awt; import java.awt.peer.CanvasPeer;,15,类/接口定义,类|接口注释 类的(静态)变量 实例变量 构造器 方法,PANFOT JAVA Developer,16,静态变量,首先是类的公共变量 随后是保护变量 再后是包一级别的变量 最后是私有变量,PANFOT JAVA Developer,17,实例变量,首先是公共级别 随后是保护级别的 再后是包一级别的 最后是私
7、有级别的,PANFOT JAVA Developer,18,方法,该按功能分组布局 非按访问区域分组 为了更便于阅读和理解代码,PANFOT JAVA Developer,19,缩进,4个空格为一个缩进单位 JBuilder缺省2个可更改|Eclipse可设置,PANFOT JAVA Developer,20,行长度,避免一行超过80字符,PANFOT JAVA Developer,21,换行(断行原则),在一个逗号后面断开 在一个操作符前面断开 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开 新的一行应该与上一行同一级别表达式的开头处对齐,P
8、ANFOT JAVA Developer,22,换行(断行原则),在一个逗号后面断开 在一个操作符前面断开 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开 新的一行应该与上一行同一级别表达式的开头处对齐 缩进后若使第二行和第三行移得很靠右，可以代之以缩进8个空格,PANFOT JAVA Developer,23,换行(断行原则),PANFOT JAVA Developer,/正常断行 someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAno
9、ther) . /若断行后很靠右，则下面行可以缩进8个空格，看上去更美 观。 private static synchronized horkingLongMethodName(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) . ,24,IF语句断行,PANFOT JAVA Developer,/缩小过少，不易阅读 1 if (condition1 ,通常使用8个缩进,看起来清晰,25,三元运算符,PANFOT JAVA Developer,1 alpha = (aLongBooleanEx
10、pression) ? beta : gamma; 2 alpha = (aLongBooleanExpression) ? beta : gamma; 3 alpha = (aLongBooleanExpression) ? beta : gamma;,三种可行的方法,26,注释,PANFOT JAVA Developer,实现注释|注释代码或者实现细节|使用/*/或/注释 |与C+相同 文档注释|Java独有,使用/* */表示|可转为HTML 不应包括|制表符和回退符之类的特殊字符 四种注释风格|块|单行|尾端|行末,27,块注释,PANFOT JAVA Developer,目的|对文件
11、，方法，数据结构和算法的描述 位置|文件开始|方法之前|方法内部,28,块注释,PANFOT JAVA Developer,首部有一空行|利于代码分隔 可以以/*-开头|indent(1)就可以将之识别为一个代码块的开始,/* * Here is a block comment. */,29,单行注释,PANFOT JAVA Developer,短注释|可以显示在一行内，与其后的代码具有一样的缩进 多于一行|不能在一行内写完，就该采用块注释,1 if (condition) 2 /* Handle the condition. */ 3 /code. 4 ,30,尾端注释,PANFOT JAV
12、A Developer,极短的注释|可以与它们所要描述的代码位于同一行 极短的注释共存|应该具有相同的缩进,1 if (a = 2) 2 return TRUE; /* special case */ 3 else 4 return isPrime(a); /* works only for odd a */ 5 ,31,行末注释,PANFOT JAVA Developer,三种风格,1 if (foo 1) 2. / Do a double-flip. 3 4 else 5. return false; / Explain why here. 6 7. /if (bar 1) 8 / / D
13、o a triple-flip. 9 / 10 /else 11 / return false; 12 /,32,文档注释,PANFOT JAVA Developer,JAVA描述信息|类、接口、构造器，方法，以及字段 注释定界符|/*.*/ 位置|应位于声明之前 ,不能在其内部,/* * The Example class provides . */ public class Example .,33,变量声明|个数,PANFOT JAVA Developer,推荐一行一个声明|因为这样利于写注释 不要|不同类型变量的声明不放在同一行,1 int level; / indentation l
14、evel int size; / size of table /这样不好 3 int level, size; 4 int foo, fooarray; /错误写法,34,变量声明|初始化,PANFOT JAVA Developer,尽量|在声明局部变量的同时初始化 或者|初始值依赖于某些先前发生的计算,可不初始化,35,变量声明|布局,PANFOT JAVA Developer,只在|代码块的开始处声明变量 不要|首次用到该变量时才声明之，for循环例外 避免|声明的局部变量覆盖上一级声明的变量,1 void myMethod() 2 int int1 = 0; / 好的声明 3 if (c
15、ondition) 4 int int2 = 0; / 不好的声时 5 . 6 7 ,36,类与接口声明,PANFOT JAVA Developer,方法名与其参数列表之前的左括号(间不要有空格 左大括号“”位于声明语句同行的末尾 右大括号“”另起一行除非是一个空语句 方法与方法之间以空行分隔,1 class Sample extends Object 2 int ivar1; 3 int ivar2; 4 Sample(int i, int j) 5 ivar1 = i; 6 ivar2 = j; 7 8 int emptyMethod() 9 . 10 ,37,简单语句,PANFOT JA
16、VA Developer,每行至多包含一条语句,1 argv+; / Correct 2 argc-; / Correct 3 argv+; argc-; / AVOID!,38,复合语句,PANFOT JAVA Developer,定义|包含在大括号中的语句序列 缩进|被括其中的语句应该较之复合语句缩进一个层次 左大括号|位于复合语句起始行的行尾； 右大括号|另起一行并与复合语句首行对齐,1 if ( this.isExist(“0001”) 2 argc-; / Correct 3 System.out.println(“HELLO”); 4 ,39,返回语句,PANFOT JAVA Developer,带返回值时|return语句不使用小括号()“ 除非|以某种方式使返回值更为显见,1. re
