《《Java编码规范》word版.docx》由会员分享，可在线阅读，更多相关《《Java编码规范》word版.docx（6页珍藏版）》请在三一文库上搜索。
1、.Java编码规范目 录1前言42命名规范42.1Package42.2File42.3Class42.4Interface42.5常量42.6变量52.7Method53文件规范53.1注释53.2Package/Imports63.3Class63.3.1构造函数64缩进排版规范65申明规范76语句规范77编程规范78JSP页面规范81 前言本文档主要是为组织内部使用Java语言进行程序开发的人员提供一个源代码书写标准，以及程序和文件的命名标准，使得能在编程时遵循一致的格式。2 命名规范2.1 Package Package的名字总是全部小写的字母采用基于项目以及服务的命名习惯，com.c
2、u.msn.ServiceName.XXX，如路由服务的数据库层包名com.cu.msn.route.dao2.2 File Java编译器强制规定文件名必须和文件中定义的public class的名称一致。2.3 Class Class的名字类名是一个名词，采用大小写混合的方式，每个单词的首字母大写，例如：BaseUser。2.4 Interface需要区分相似的class的名，Interface 以I开头，同时后面的第二个字母大写，例如：IbaseUser.java。2.5 常量常量的声明应该全部大写，每个单词之间用"_"连接。例如：final String WWW_C
3、ROSSTEK_CN = ""2.6 变量 变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短且可以顾名思义，易于记忆。例如：crosstekName、crosstekAddress。避免单个字符的变量名，除非是一次性的临时变量。2.7 Method方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。例如：setCrosstekName(String neekeName)。 3 文件规范3.1 注释在所有的Java（*.java）文件都必须遵守如下的样式规则。示例： /* * <p>Title: 类名<
4、/p> * <p>Description: 类的功能描述</p> * <p>Copyright: All Rights Reserved</p> * <p>Company: 北京飞天经纬</p> * author 作者 * created date 创建时间*/3.2 Package/Importspackage行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*号来处理。Package .stats；Import j
5、ava.io.*；Import java.util.Observable；Import hotjava.util.Application；这里java.io.* 使用来代替InputStream and OutputStream的。3.3 Class3.3.1 构造函数接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型 （"public"， "private" 等.）和任何"static"，"final"或"synchronized"应该在一行中，并且方法和参数另写一行，
6、这样可以使方法和参数更易读。如：publicCounterSet（int size）this.size=size； 4 缩进排版规范（1）避免一行的长度超过60个字符。（2）使用Eclipse的源代码的格式化功能完成代码的缩进排版。（jsp页面不要使用格式化工具排版） 5 申明规范（1）一行声明一个变量。（2）不要将不同类型变量的声明放在同一行。（3）只在代码块的开始处声明变量。（4）所有的变量必须在声明时初始化。（5）避免声明的局部变量覆盖上一级声明的变量。（6）方法与方法之间以空行分隔 6 语句规范（1）每行至少包含一条简单语句。（2）在return语句中，返回值不使用小括号"(
7、)"括起来。（3）if语句总是用""和""括起来。（4）在for语句的初始化或更新子句中，避免因使用三个以上变量，而导致复杂度提高。（5）当switch的一个case顺着往下执行时（因为没有break语句），通常应在break语句的位置添加注释。7 编程规范（1）提供对实例以及类变量的public或private访问控制，尽可能不使用默认值或protected访问控制。（2）避免用一个对象访问一个类的静态变量或方法。应该用类名代替。（3）避免在一个语句中给多个变量赋相同的值。（4）用switch()语句实现多路分支。（5）如果使用JDBC，则考
8、虑使用java.sql.PreparedStatement，而不是java.sql.Statement。（6）用于设置对象状态的方法前缀必须是set；用于检索一个布尔类型对象状态的方法前缀必须是is，而用于检索其他方法前缀必须是get。（7）程序中应尽可能少使用数字（或字符），尽可能定义静态变量来说明该数字（或字符）的含义。程序中需要赋值或比较时，使用前面定义的静态变量。在循环控制中例外。发布出去的文件不能有System.out.println()类似的打印语句 8 JSP页面规范页面名称都用小写字母，每个单词之间用"_"连接。页面不能有打印语句每个页面添加如下的代码去除页面缓存<meta http-equiv="Pragma" content="no-cache"/><meta http-equiv="Cache-Control" content="no-cache"/><meta http-equiv="Expires" content="0"/>第 6 页 共 6 页