Java编程规范28740.docVIP

Java编程规范 前言 本编程规范参照Java的基本编码规范。 命名规则 所有命名都以有现实意义的英语单词或缩写为基础，不能用汉语拼音等代替。 在可以准确表达名称含义的条件下，命名应尽量简短。 包的命名：包字全部由小写字母组成，以“.”来分隔包的标识。 基本包：com.项目名.模块名.类型 例如：com.shop.user.entity 实体类：.entity或.dto DAO：.dao Action：.action或.service Servlet：.servlet 通用包：.util 过滤器：.filter 类的命名：由大写字母开头、其他字母都小写的单词组成。 例如：Person 接口的命名：名称加前缀“I”，后面部分与类的命名规则一致。 例如：IUserDAO 属性/变量的命名：属性名称应该使用完整的英文来描述。用一个小写字母开头，后面每个单词以大写字母开头。 例如：index, userName 成员方法的命名：用一个小写字母开头，后面每个单词以大写字母开头。 例如：run(), getName() static final变量的命名：所有字母都大写，每个单词间用下划线“_”隔开，并且能表示完整含义。 例如：PI，PASSWORD，ROLE_NAME 参数的命名 参数的名字和变量的命名规范一致(见4)。 数组的命名 由一个小写字母开头，后面每个单词以大写字母开头，最后以字母s结尾。例如：byte[] buffers 文件样式 版权信息必须在 java 文件的开头，先于package /** *Copyright ? 2000 Shanghai XXX Co. Ltd. *All right reserved. */ package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。 package hotlava.net.stats; import java.io.*; import java.util.Observable; import hotlava.util.Application; 类定义。例如： /** *A class representing a set of packet and byte counters *It is observable to allow it to be watched, but only *reports changes when the current set is complete */ public class User{ } 类定义中的extends 和 implements 必须写在不同行。例如： public class CounterSet extends Observable implements Cloneable 类中变量的定义。例如： /** *Packet counters */ protected int[] packets; 类中方法的定义。例如： /** *Get the counters *@return an array containing the statistical data. This array has been *freshly allocated and can be modified by the caller. */ public int[] getPackets() { return copyArray(packets, offset); } public int[] getBytes() { return copyArray(bytes, offset); } 代码编写格式 简单语句：每行最多包含一条语句 例如：i++; return i; 复合语句：由一组“{}”括起来的语句 嵌套在内层的语句应该比外层的语句缩进一个Tab长度。 左大括号应该放在开始语句的行的末尾，右大括号应该单独一行，并且和开始语句左对齐。 当语句是控制结构（如if-else）的一部分时，在所有的语句外面添加大括号，包括单行。这样不会造成意外的程序错误。 例1： 下面的第1行是错误的, 第2行是正确的: 　　 if (i0) { i ++ }; // 错误, “{”和 “}” 在同一行 　 　 if (i0) { //正确写法一 　　 i ++ ; 　　 } if (i0) //正确写法二 { 　 i ++ ; 　　 } 括号 左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也