Java编程规范

Java

编程规范

 

本编程规范建立在标准的

Java

编程规范的基础上，如和标准的

Java

编程规范有冲突，

以本编程规范为准。

1.1 

程序结构

包名

引入包

/

类名

类注释

类

常量//

常量注释

构造器注释

构造器

构造器注释

构造器

方法注释

方法

方法注释

方法

1.2 

命名规范

命名规范使得程序更易理解，可读性更强。并且能够提供函数和标识符的信息。

 

文件命名规范：

java

程序使用如下的文件名后缀：文件类型后缀Java 源文件.java Java 字节码文件.class 对系统的文件命名方式有待于根据实际业务决定。

 

包命名规范：包名应该唯一，它的前缀可以为任何小写的ASCII字符，包名按照公司内部的命名规范，这

些规范指出了某种目录名，主要包括部门，项目，机器，或者登录名。

 

命名规则为：app.系统名.模块名.xxx.xxx 

包命名举例：

app.oa.interceptor.xxx 

app.oa.sys.xxx 

类命名规范：类名应该是名词，并且是大小写混合的。首字母要大写。尽量保证类名简单并且描述性强。

避免使用只取单词首字母的简写或者单词的缩写形式，

除非缩写形式比单词的完整形式更常

用（例如：URL或者HTML）

。文件名必须和public的类名保持一致，注意大小写（JBuilder等一些编译器可以忽略大小写，要特别注意）

。如是实现类命名后缀+Impl。

类命名举例：

classLoginAction; 

classUserServiceImpl; 

接口命名规范：接口命名方式与类命名方式相同。

接口命名举例：

interfaceIUserService; 

interfaceSysYhjsDAO; 

 方法命名规范；

方法名应该为动词，并且是大小写混合的。首字母要小写，方法名的第二个单词的第一个字母大写。

 

方法命名举例：

String getNoticeNo(); 

Collection findByCondition(String); 

变量命名规范

 变量，以及所有的类实例应为首字母小写的大小写混合形式。变量名的第二个单词的首字母大写。变量名的首字母不能为下划线或者$符。

 

变量名应该尽可能的短小，但要有意义。变量名应该便于记忆，也就是说变量名应

该尽可能的做到见名知意。除了暂时使用的变量外（一般用于循环变量），应该避免使用只有一个字母的变量名。对于临时变量一般说来：

i，j，k，m，n代表整型变量。c，d，e代表字符型变量。

变量命名举例：

String dataType; 

String name; 

inti; 

char c; 

常量命名规范：声明为类常量的变量或者

ANSI

常量应该全部为大写字母，并且每个单词间用下划线“_”隔开。为了便于调试，应避免使用ANSI常量。

常量命名举例：

 

static final int MIN_WIDTH = 4; 

 

1.3 注释规范Java 提供了两种类型的注释：程序注释和文档注释。程序注释是由分隔符

/*

„

*/，

和// 隔开的部分，这些注释和C++ 中的注释一样。文档注释（即“doc 注释”）是Java 独有的。由分隔符

/**

„

*/

隔开。使用

javadoc

工具能够将文档注释抽取出来形成

 

HTML 

文件。程序注释主要是对程序的某部分具体实现方式的注释。文档注释是对程序的描述

性注释，主要是提供给不需要了解程序具体实现的开发者使用。注释应该是代码的概括

性描述，提供不易直接从代码中得到的信息，并且只包含对阅读和理解程序有用的信息。

例如注释中包含相应的包如何编译或者在哪个目录下，而不应该包括这个包驻留在哪儿

的信息。注释中可以描述一些精妙的算法和一些不易理解的设计思想，但应该避免那些

在程序代码中很清楚的表达出来的信息。尽可能的避免过时的信息。错误的注释比没有

注释更有害。经常性的注释有时也反映出代码质量的低下。

程序注释：

程序注释有四种格式：块注释格式，单行注释，跟随注释，行尾注释

¾块注释格式

块注释主要用于描述：文件、方法、数据结构和算法。一般在文件或者方法定义的

之前使用。也可以用在方法定义里面，如果块注释放在函数或者方法定义里，它必须与

它所描述的代码具有相同的缩进形式。

 

块注释应该用一个空行开头，以便于代码部分区分开来。

块注释举例：

/* 

* Here is a block comment. 

*/ 

单行注释比较短的注释可以放在一行中，但必须与它所跟随的代码有相同的缩进。如果注释不可以放在一行，那么必须按照块注释的格式来写。单行的注释会被解释为一空行。

单行注释举例：

if (condition) { 

/* Handle the condition. */ 

... 

} 

跟随注释非常短的注释可以和它所描述的代码放在同一行。但要保证代码和注释之间有足够的间隔。在同一块代码中不止一个这样的注释时它们应该对齐。

 

跟随注释举例：

if (a == 2) { 

return TRUE; /* special case */ 

} else { 

returnisPrime(a); 

/* works only for odd a */ 

} 

行尾注释

注释标记“

//

”能够注释一行或者该行由“

//

”开始直到行尾的部分。行尾注释不

能用在多行文本注释中。但它可以将多行代码注释掉。这三种注释方法举例如下。

if (foo > 1) { 

// Do a double-flip. 

... 

} 

else{ 

return false; 

// Explain why here. 

} 

//if (bar > 1) { 

// 

// // Do a triple-flip. 

// ... 

//} 

//else{ 

// return false; 

 //} 

文档注释： 文档注释描述了Java类，接口，构造函数，方法和属性。每个文档注释放在文档注释符/**„*/中。

每个类、接口或者成员只在声明的地方之前有一个文档注释。