JAVA编码规范-V1.0

JAVA编程规范

2.7括号

使用括号的目的必须是在表达上不但能够标明优先顺序，而且有助于使表达更简单明了。另外，如果某一段代码有可能产生歧义，也需加括号。

9 / 17

JAVA编程规范

3 命名规则

所有的标识符只能用字母（A-Z或a-z）和数字（0-9）。不能有货币符号或者其它非ASCII字符，尽量少用数字。

3.1 类和接口

所有类和接口标识符将都使用混合\格\表示。每个名称中的每个单词首字母必须大写，同时这个名称的首字母也必须大写；其它的字母均小写，除了缩写词之外（它们必须全部大写）。 示例： Customer SalesOrder TargetURL URLTarget

3.2 包

所有包名只能用小写字母。尽量别使包名长度超过8个字符，应该避免使用多个词作为包名。 示例： common core lang

3.3 get和set方法（属性的定义）

使用Eclipse的自动代码生成get和set方法。

变量不要使用前缀，变量的类型在名称后面表示，如：SystemDate，后面表示类型。以免生成的方法不方便使用。

10 /

17

JAVA编程规范

3.4 变量

3.4.1 普通变量：

变量的命名应尽可能采用见名知义，基本命名规则如下： 变量名 = 变量含义 （+ 变量后缀） 后缀不一定要使用

变量后缀遵循规则，定义如下：

3.4.2 常用对象变量

类型 Vector HashMap Hashtable Date Timestamp Collection Iterator List Object[] 前缀 v hm ht Date Time coll it L aryObj 3.4.3 Static Final变量的命名

Static Final 变量的名字应该都大写，每个单词之间用 ”_” 连接，并且指出完整含义。

3.4.4 临时变量

一般临时变量没有具体的意思，所以临时变量名为： 临时变量名 = 变量前缀 + （Temp或Tmp）；

其中有一些C语言延续下来的常见临时变量也可以接受：如i , j , k 一般用于表示一个临时整型变量。

11 /

17

JAVA编程规范

4 注 释

大部分注释尽量用\；对于所有的javadoc的注释则用\；而临时对代码块进行的注释尽量用\。

使用时在Eclipse中输入/**，回车即可自动生成JavaDoc的注释格式。

4.1 要求

1、 程序中注释行应不少程序代码行的40%； 2、 类、方法、变量必须注释说明；

3、 注释内容应根据客户要求的语言进行，原则上，除常量、变量、变量类型等以外的说明尽可能采用中文注释；

4.2 JavaDoc说明

1）．JavaDoc注释将用于说明那些被其它类调用的类、属性和方法。这些注释必须出现在所要说明的各项之前。 2）．JavaDoc注释一般不会用于说明一些显而易见的方法，例如：

public static void main( String[ ] args ) 或public int getX( ) ； 3）．JavaDoc注释也不用于说明一些显而易见的参数，如：

public void setX( int newX ) ； 4）．诸如servlet和EJB等那些没有被其它类调用的类，也不必加JavaDoc注释。

把源码上交给整个团队之前，必须先经过JavaDoc处理，并全面检查处理结果，以确定说明文字确实可读而且清楚明白。

如果JavaDoc注释能够在一行内写下，则格式应该象下面这样：

/** Used to mark spots */ int x ;

如果JavaDoc注释内容在一行内容纳不下，则其格式应该象下面这样： /** Set how much to grow when growth is needed.

* Smaller values will usually save memory, but frequent * reallocation may take a lot of time.

* @param HowMuch The number of extra ints to allocate when

* memory reallocation is required. Values must be greater than * zero.

*/

public void setExtra( int HowMuch )

{

……

12 /

17