《java编码规范》word版

《《java编码规范》word版》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

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页面规范8第6页共6页1前言本文档主要是为组织内部使用Java语言进行程序开发的人员提供一个源代码书写标准，以及程序和文件的命名标准，使得能在编程时遵循一致的格式。2命名规范2.1PackagePackage

2、的名字总是全部小写的字母采用基于项目以及服务的命名习惯，com.cu.msn.ServiceName.XXX，如路由服务的数据库层包名com.cu.msn.route.dao2.2FileJava编译器强制规定文件名必须和文件中定义的publicclass的名称一致。2.3ClassClass的名字类名是一个名词，采用大小写混合的方式，每个单词的首字母大写，例如：BaseUser。2.4Interface需要区分相似的class的名，Interface以I开头，同时后面的第二个字母大写，例如：IbaseUser.java。2.5

3、常量常量的声明应该全部大写，每个单词之间用"_"连接。例如：finalStringWWW_CROSSTEK_CN="www.crosstek.cn";第6页共6页1.1变量变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短且可以顾名思义，易于记忆。例如：crosstekName、crosstekAddress。避免单个字符的变量名，除非是一次性的临时变量。1.2Method方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。例如：setCrosstekName(Stringn

4、eekeName)。2文件规范2.1注释在所有的Java（*.java）文件都必须遵守如下的样式规则。示例：/***

Title:类名

Description:类的功能描述

Copyright:AllRightsReserved

Company:北京飞天经纬

5、ort行中包含了同一个包中的不同子目录，则应该用*号来处理。Packagehotjava.net.stats；Importjava.io.*；Importjava.util.Observable；Importhotjava.util.Application；这里java.io.*使用来代替InputStreamandOutputStream的。1.2Class1.2.1构造函数接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型（"public"，"private"等.）和任何"static"，"final

6、"或"synchronized"应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。如：publicCounterSet（intsize）{this.size=size；}2缩进排版规范（1）避免一行的长度超过60个字符。（2）使用Eclipse的源代码的格式化功能完成代码的缩进排版。（jsp页面不要使用格式化工具排版）第6页共6页1申明规范（1）一行声明一个变量。（2）不要将不同类型变量的声明放在同一行。（3）只在代码块的开始处声明变量。（4）所有的变量必须在声明时初始化。（5）避免声明的局部变量覆盖上一级声明的

7、变量。（6）方法与方法之间以空行分隔2语句规范（1）每行至少包含一条简单语句。（2）在return语句中，返回值不使用小括号"()"括起来。（3）if语句总是用"{"和"}"括起来。（4）在for语句的初始化或更新子句中，避免因使用三个以上变量，而导致复杂度提高。（5）当switch的一个case顺着往下执行时（因为没有break语句），通常应在break语句的位置添加注释。3编程规范（1）提供对实例以及类变量的public或private访问控制，尽可能不使用默认值或protected访问控制。（2）避免用一个对象访问一个类的

8、静态变量或方法。应该用类名代替。（3）避免在一个语句中给多个变量赋相同的值。第6页共6页（4）用switch()语句实现多路分支。（5）如果使用JDBC，则考虑使用java.sql.PreparedStatement，而不是java.sql.Statement。