1.1Java编程规范.PDF

1.1 Java 编程规范 本编程规范建立在标准的Java 编程规范的基础上，如和标准的Java 编程规范有冲突， 以本编程规范为准。 1.1.1 程序结构 包名 引入包/类名 类注释 类 常量//常量注释 构造器注释 构造器 构造器注释 构造器 方法注释 方法 方法注释 方法 1.1.2 命名规范 命名规范使得程序更易理解，可读性更强。并且能够提供函数和标识符的信息。 文件命名规范 java 程序使用如下的文件名后缀： 文件类型 后缀 Java 源文件 .java Java 字节码文件 .class 对系统的文件命名方式有待于根据实际业务决定。 包命名规范 包名应该唯一，它的前缀可以为任何小写的ASCII字符但必须是顶级域名，目前包 括com, edu, gov, mil, net, org,或者ISO标准3166,1981中两个字符的国别代码。包名接下 来的部分按照公司内部的命名规范，这些规范指出了某种目录名，主要包括部门，项目， 机器，或者登录名。 命名规则为： com.sinosoft.系统名[.模块名].xxx.xxx 具体参错误！未找到引用源。 包命名举例： com.sinosoft.platform.bl.facade com.sinosoft.platform.dto.domain 类命名规范 类名应该是名词，并且是大小写混合的。首字母要大写。尽量保证类名简单并且描 述性强。避免使用只取单词首字母的简写或者单词的缩写形式，除非缩写形式比单词的 完整形式更常用（例如：URL 或者HTML ）。 文件名必须和public 的类名保持一致，注意大小写（JBuilder 等一些编译器可以忽 略大小写，要特别注意）. 类命名举例： class PolicyOverviewDto; class DBPrpDuser.java; 接口命名规范 接口命名方式与类命名方式相同。 接口命名举例： interface PolicyOverview; interface PolicyOverviewSessionHome; 方法命名规范 方法名应该为动词，并且是大小写混合的。首字母要小写，方法名的第 二个单词的第一个字母大写。 方法命名举例： String getNoticeNo(); Collection findByCondition(String) 变量命名规范 变量，以及所有的类实例应为首字母小写的大小写混合形式。变量名的第二个单词 的首字母大写。变量名的首字母不能为下划线或者$符。 变量名应该尽可能的短小，但要有意义。变量名应该便于记忆，也就是说变量名应 该尽可能的做到见名知意。除了暂时使用的变量外（一般用于循环变量），应该避免使 用只有一个字母的变量名。对于临时变量一般说来：i，j ，k ，m ，n 代表整型变量。c， d，e 代表字符型变量。 变量命名举例： String dataType; String name; int i; char c; 常量命名规范 声明为类常量的变量或者ANSI 常量应该全部为大写字母，并且每个单词间用下划 线“_ ”隔开。为了便于调试，应避免使用ANSI 常量。 常量命名举例： static final int MIN_WIDTH = 4; 标准资料收藏家 易启标准网免费提供十万标准书籍资料下载