java常用编码规范.docxVIP

Java 编码规范术语Pascal case － 所有单词第一个字母大写，其它字母小写。例：Person, OrderDetail, OilTank。Camel case － 除了第一个单词，所有单词第一个字母大写，其他字母小写。例：oilLevel, customerName在后面的描述中我们使用 Pascal 代表第一种表示方式， Camel 代表第二种表示方式。约束没有一个规范可以到处适用，也不可能无所不包。1．本规范并非完全强制性规范，对于任何违背本规范但能提高代码可读性的措施，都可以采用。2．本规范第 3，4，5 章为强制性规范，其它章节为建议规范。如违背本条，请参考第一条。一般规则1．所有包，类，接口，方法，属性，变量，参数均使用英文单词进行命名，具体细节请参见命名规范一章。2．命名包，类，接口，方法以及变量时，尽量使用贴近问题域的表意丰富的名称。3．修改源代码时，应尽量保持与所修改系统的编码风格保持一致。4．所有包名使用必须使用 com.[company]前缀，所有项目使用com.[company].projects.[project name], company 是公司简称，project name 是项目的缩写。格式规范1．包的导入应该按照相关性进行分组。import java.io.IOException;import .URL;import java.rmi.RmiServer;import java.rmi.server.Server;import javax.swing.JPanel;import javax.swing.event.ActionEvent;import org.linux.apache.server.SoapServer;2．只倒入明确需要的类，这样只要看导入列表，就可以知道该类依赖于哪些类和接口，保证可读性。import java.util.List; // 避免: import java.util.*import java.util.Arraylist;import java.util.HashSet;3．类和接口中元素的布局顺序。（1）类和接口的文档描述（2）类和接口的声明（3）类的静态变量，按照 public，protected，package，private 的顺序。（4）实例变量，按照 public，protected，package，private 的顺序。（5）类的方法，无固定顺序。4．方法修饰关键字定义顺序。public, protected, private static abstract synchronized unuaual final native methodName 注意访问标示符一定要在最前面。public static double square(double a);//避免: static public double square(double a);5．变量声明，采用 Camel 表示法不要在一行声明多个变量。//推荐int level;int size;//避免int level, size;6．数组指示符紧跟类型变量int[] a = new int[20]; // 避免: int a[] = new int[20]一个变量要代表独立的意思，不要在其生命周期赋予它不同的概念。int tempValue;tempValue = maxValue;…tempValue = minValue;…tempValue = anotherValue;tempValue 在生命周期内表示了各种各样的意图，增加理解代码的难度。应该为每个独立概念定义单独的变量：int tempMaxValue;int tempMinValue;int tempAnotherValue;7．循环变量应靠近循环体初始化isDone = falsewhile(!isDone){…}//避免isDone = false;……while(!isDone){…}8．避免长的布尔表达式，应换成多个更容易理解的表达式。bool isFinished = (elementNo 0) || (elementNo maxElement);bool isRepeatedEntry = elementNo == lastElement;if (isFinished || isRepeatedEntry) {…}// 避免if ((elementNo 0) || (elementNo maxElement)|| elementNo ==lastElement) {…}9．不要在条件语句中执行方法，以提高可读性InputStream stream = File.open(fileName, w