JavaCoding规范

红色代码为错误示范，绿色代码为正确示范 一、 名称统一使用英文命名，不使用拼音命名或拼音+英文组合的命名。 public boolean hasWanCheng(){ }

public boolean hasFinish(){ }

二、 变量名采用驼峰命名法，用有意义的单词前缀或后缀来区别两个含义不同的变量，不使用大小来区分，不使用加无意义数字后缀区分。

private int number; private int Number; private int number1; private int number2;

private int carNumber; private int trainNumber;

三、 包名采用全小写单词。包名与变量名相同，不使用无意义数字后缀。 dyx.co.isid.FrameWork.Banking.ACCOUNT dyx.co.isid.framework.banking.a00001

dyx.co.isid.framework.banking.account dyx.co.isid.framework.banking.account

四、 类名首字母大写，与变量名相同，不使用无意义数字后缀。 public class S0001 { } public class sampleclass { }

public class Sample { } public class SampleClass { }

五、 实现接口或抽象父类的实现类，以“Impl”结尾。 public class SampleImpl implements ISample { }

六、 方法名首字母小写，与变量名类似。 public void BadSample(int number){ }

public void setNumber(int number){ }

七、 方法名要使用动词性质的单词，并能真实表达含义。如：创建某一个实例的方法名，以create或意思相近的单词开始，跳转或进入以to、enter开始。

public Sample createSample(){ } public Another toAnother(){ }

八、 返回类型为boolean型的方法名，要能表达判断的含义，可以是象exists这样能表达判断含义的单词，也可以使用is+名词/形容词、can+动词、has+名词/动词的过去分词等组合来表达，方法名所要表达含义为：满足方法名的描述，结果就为true，如：

public boolean isAsleep(){//如果是沉睡的这样一种状态，结果为true。 } public boolean canSpeak(){//如果能够说，结果为true。 } public boolean hasExpired(){//如果已经过期，结果为true。 } public boolean exists(){//如果存在，结果为true。 } public boolean hasValue(){//如果有值，结果为true。 }

九、 boolean变量名与返回类型为boolean型的方法名相似。 private boolean isAsleep; private boolean canSpeak; private boolean hasExpired; private boolean exists; private boolean hasValue;

十、 常量的定义，名称全大写，单词之前用“_”切分。 public static final int SampleValue = 10; public static final int SAMPLE_VALUE = 10; 十一、for循环与嵌套for循环，控制循环次数的临时变量应按照i、j、k„„这样的顺序命名。 for（int j = 0; j < 10; j++）{ ... for(int n = 0; n < 10; n++){ ... for(int t = 0; t < 10; t++){ } } }

for（int i = 0; i < 10; i++）{ ... for(int j = 0; j < 10; j++){ ... for(int k = 0; k < 10; k++){ } } }

十二、除特殊需要外，尽可能使用接口类型定义变量，而不用实例类型。 ArrayList sampleList = new ArrayList (); List sampleList = new ArrayList (); 十三、不使用当前JDK版本下不推荐使用但JDK中依然保留的方法。 Date sampleDate = new Date(); System.out.println(sampleDate.getYear());

Calendar sampleCalendar = Calendar.getInstance(); System.out.println(sampleCalendar.get(Calendar.YEAR));

十四、不在程序中出现未曾使用过的私有变量、私有方法，一般开发环境也会以黄色提示。 十五、严格使用public、private、protected修饰符，类中不可能被第二个类调用的方法、变量等不要用public来代替private。

十六、用空格控制代码格式的规范： 1、 用“,”间隔的参数列表，for循环中用“;”间隔的执行语句，“,”、“;”与前面代码之间不空格，与后面代码之间空一格。

public void badSampleMethod(int score,int number){ } for (int i = 0;i < 1000;i++){ }

public void fixedSampleMethod(int score, int number){ } for (int i = 0; i < 1000; i++){ }

2、 各种算术运算符、逻辑运算符、赋值运算符等与前后变量之间空一格。 ①a=1; ②b-=a;

①a = 1; ②b -= a;

3、“++”、“--”要紧跟变量名，不空格。 a ++; a++; 十七、boolean型变量或方法返回，在做判断条件时还需要与true或false比较判断吗？ ①while(hasStock == true) { } ②if(hasStock == false){ }

①while(hasStock) { } ②if(!hasStock){ }

十八、不要导入无用的包，一般开发环境会给出黄色提示，也不要用“*”把一个包下所有的类全导入进来，用到某个类只导入该类。

十九、静态方法、静态变量属于类，而不属于某个对象，不要用对象来调用静态方法。 public class BadSample { public static void sampleClassMethod(){} public void sampleMethod(){ BadSample object = new BadSample(); object.sampleClassMethod(); } }

public class FixedSample { public static void sampleClassMethod(){} public void sampleMethod(){ FixedSample object = new FixedSample(); FixedSample.sampleClassMethod(); } }

二十、不要在一行内申明多个变量。 private String firstName, lastName; private String firstName; private String lastName;

二一、程序中要使用的定值，应定义常量后使用。 private int[] sampleArray = new int[10]; private static final int ARRAY_SIZE = 10; private int[] sampleArray = new int[ARRAY_SIZE];

二二、严格按照变量实际使用情况确定作用域。如：只在方法内使用的临时变量不要定义为成员变量，除特殊情况外，循环体里不申明临时变量，应将循环体内要用的临时变量放在循环体外申明。

private int value; public void calcValue(SomeObj inValue){ value = inValue.getData(); for(int i = 0; i < value; i++){ StringBuffer sampleBuffer = new StringBuffer(); „„ } }

public void calcValue(SomeObj inValue){