Java编码规范

规范开发的好帮手

附录A: Java编码规范

一、 Java命名的一般性指导

1. 类名首字母应该大写。属性(成员变量)、方法、对象变量以及所有标识符(如形式参数、实际参数、局部变量)的首字母应小写,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。

例如:类名:ThisIsAClassName 属性或方法名:thisIsMethodOrFieldName 对象变量:thisIsAClassVariable

2. Java包(Package)属于一种特殊情况,它们全都是小写字母,即便中间的单词亦是如此。对于全局包,将你的 Internet 域名反转并接上包名,

例如:http://www.wendangwang.comst.dingyuewei.package

另外,package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。例如

package http://www.wendangwang.com.stats;

import java.io.*;

import java.util.Observable;

import hotlava.util.Application;

这里 java.io.* 是用来代替InputStream and OutputStream 的。

3. 接口(Interface):采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er。

例如:Contactable,Prompter。

4. 组件(Component)使用完整的英文描述来说明组件的用途,末端应接上组件类型。 例如:okButton,customerList,fileMenu。

5. 类中常用方法的命名:

l 类的获取方法(一般具有返回值)一般要求被方法名使用被访问字段名,前面加上前缀get,如getFirstName(), getLastName()。

l 类的布尔型的判断方法一般要求方法名使用单词 is 做前缀,如isPersistent(), isString()。或者使用具有逻辑意义的单词,例如equal或equals

l 类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,如setFirstName(),setLastName(),setWarpSpeed()。

l 类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用一个生动的动词,第一个字母小写,如 openFile(), addAccount()。

l 构造方法应该用递增的方式写(比如:参数多的写在后面)。

例如:

public CounterSet(){}

public CounterSet(int size){ this.size = size;}

l toString 方法:一般情况下,每一个类都应该定义 toString 方法,其格式为 : public String toString() {…}

l 一般应考虑置入一个main()方法,其中包含用于测试那个类的代码,如果包含了main() 方法, 那么它应该写在类的底部。

6. 静态常量字段(static final)一般全部采用大写字母,单词之间用下划线分隔(也有特例,如Java类库中关于颜色的常数没有严格地全部使用大写字母)。如MIN_BALANCE,

Word文档免费下载Word文档免费下载:Java编码规范 (共5页,当前第1页)

你可能喜欢

  • Android编码规范
  • C++编码规范
  • php编码规范
  • java编码规范
  • 物料编码规范
  • 华为编码规范
  • 软件编码规范
  • 金融机构编码规范

Java编码规范相关文档

最新文档

返回顶部