java编码规范

1、JAVA编码规范20112212404 赵磊 JAVA编码规范的重要性 一个软件的生命周期中，80%的花费在于维护。 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。 如果你将源码作为产品发布，就需要确认它是否被很好的打包并清晰无误，一如你已构建的其它任何产品。JAVA编码规范u 1 ：文件名u 2：文件组织u 3：缩进排版u 4：注释u 5：声明u 6：语句u 7: 空白u 8：命名规范1：文件名1.1文件后缀文件类别文件类别文件后缀文件后缀Java源文件.javaJava字节码文件.classjsp界

2、面文件.jspZk界面文件.zulHtml界面文件.html1：文件名1.2常用文件名文件名文件名用途用途src应用源代码存放文件夹test单元测试源代码存放文件夹pages存放界面文件resources存放资源文件css存放css文件Img存放图片文件Js存放javascript文件I3-label_zh_CN.propertiesZK的国际化文件2:文件组织 一个文件由被空行分割而成的段落以及表示每个段落的可选注释共同组成。不能有超过2000行的程序。2:文件组织2.1 java源文件 每个java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入

3、同一个源文件。公共类必须是这个文件中的第一个类或接口。2:文件组织2.1.1 开头注释2:文件组织2.1.2包和引入语句 在多数java源文件中，第一个非注释行是包语句。在它之后跟以内语句。列如：2:文件组织2.1.3 类和接口的注释2:文件组织2.1.4 方法的注释以”/*”开始，”*/”结束注释。写明程序作用，以及输入输出参数和异常。列如：2:文件组织3.1.5 属性的注释以”/*”开始，”*/”结束注释。写明该属性的含义。列如：2:文件组织3.1.6 方法内的注释语句末尾以“/”开始注释。列如：2:文件组织3.1.7 修改程序时的注释 1：增加代码。列如： 2：修改代码。修改，删除代码的

4、时候保留原来的程序代码，不要直接修改或删除。用“/* */”或者“/”进行注释后再做修改和删除。列如 3：删除代码 列如： 3：缩进排版 4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定（空格 vs 制表符）。一个制表符等于8个空格（而非4个）3：缩进排版3.1 行长度 一行的长度不能超过80个字符，因为很多终端和工具不能很好的处理之。注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。3：缩进排版3.2 换行 当一个表达式无法容纳在一行时，可以根据如下一棒规则断开之: 在一个逗号后面断开 在一个操作符前面断开（注：在一个操作符后面断开更好。）以下是断开方法调用的

5、一些例子： 4:注释 java 程序有两类注释：实现知识和文档注释。实现注释是那些在C+中见过的，使用/和/界定的注释。文档注释是java独有的，并由/*/界定。文档注释可以通过javadoc工具转换成HTML文件。4:注释4.1 文档注释 文档注释描述java的类，接口，构造器，方法，以及字段。每个文档注释都会被置于注释定界符/*/之中，一个注释对应一个类，接口或成员。注释应为于声明之前。5：声明5.1 每行声明变量的数量一行一个声明，因为这样有利于鞋注释。亦即：5：声明5.2 初始化声明局部变量的同时初始化，唯一不这么做的理由是变量的初始化值依赖于某些先前发生的计算。5：声明5.3 类和接

6、口的声明 当编写类和接口时，应该遵循以下格式规则： 在方法名与其参数列表之前的左括号间不要有空格。 左大括号位于声明语句同行的末尾 右大括号另起一行，与相应的声明语句对齐，除非是一个空语句，右大括号应紧跟在左大括号之后 方法与方法之间以空行分隔6：语句6.1 简单语句每行之多包含一条语句，列如：6：语句7.2 返回语句一个带返回值的return语句不使用小括号，除非它们以某种方式使返回值更为显现。列如：7：空白7.1 空行 空行将逻辑相关的代码段分隔开，以提高可读性。 下列情况应该总是使用两个空行; 一个源文件的两个片段之间 类声明和接口声明之间下列情况应该总是使用一个空格 两个方法之间 方法

7、内的局部变量和方法的第一条语句之间 块注释或单行注释之前 一个方法内的两个逻辑变量之间，用以提高可读性8：命名规范8.1 包命名8：命名规范8.2类命名8：命名规范8.2.1 类名8：命名规范9.2.2 抽象类 在使用模式进行设计时，为了加强抽象类的作用，用Abstract作为类的前缀。 列如：AbstractFactory 8：命名规范9.2.3 接口类特别注明接口类，类加上一个前缀I。列如;ICircle8：命名规范8.2.4 实现类 接口类本身是不能被实例化的，其包含的操作方法是在其子类中实现，常称为“实现类”，给该类加上一个后缀Impl，成为程序员的一种通行的惯例。列如：CricleImpl8：命名规范8.2.5 界面逻辑类控制界面中的元素并实现其逻辑关系的类，在该类加上一个后缀Ui。列如：UserInforAddUi8：命名规范8.2.6数据库实体类TB+下划线+类名，TB是table的缩写。如TB_User。8.2.7业务实体类CB+下划线+类名，CB是entit