Java命名规则详细总结

时间:2021-12-18 10:18:50

1. JAVA源文件的命名  JAVA源文件名必须和源文件中所定义的类的类名相同。

2. Package的命名  Package名的第一部分应是小写ASCII字符,并且是*域名之一,通常是com、edu、gov、mil、net、org或由ISO标准3166、1981定义的国家唯一标志码。Package名的后续部分由各组织内部命名规则决定,内部命名规则指定了各组件的目录名,所属部门名、项目名等。   

3. Class/Interface的命名  Class名应是首字母大写的名词。命名时应该使其简洁而又具有描述性。异常类的命名,应以Exception结尾。Interface的命名规则与Class相同。

4. 常量的命名  常量名的字母应全部大写,不同的单词之间通过下划线进行连接,并且名字组合应该赋予含义。

5. 变量的命名

5.1 普通变量  普通变量名的首字母小写,其它每个单词的首字母大写。命名时应该使其简短而又有特定含义,简洁明了的向使用者展示其使用意图。    

5.2 约定变量  所谓约定变量,是指那些使用后即可抛弃(throwaway)的临时变量。通常i、j、k、m和n代表整型变量;c、d和e代表字符型变量。

6. 方法的命名  方法名的第一个单词应是动词,并且首字母小写,其它每个单词首字母大写。  

7. 方法参数的命名  应该选择有意义的名称作为方法的参数名。如果可能的话,选择和需要赋值的字段一样的名字。  

补充资料:

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

2、Java 包(Package)属于一种特殊情况,它们全都是小写字母,即便中间的单词亦是如此。对于全局包,将你的Internet 域名反转并接上包名。例如: 
cn.edu.usst.dingyuewei.package。 
另外,package 行要在import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。例如: 

package hotlava.net.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、类中常用方法的命名: 

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

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

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

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

e)构造方法应该用递增的方式写(比如:参数多的写在后面)。例如: 
public CounterSet(){} 
public CounterSet(int size){ this.size = size;} 

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

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

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

7、循环计数变量通常采用字母 i,j,k 或者 counter。而数组应该总是用下面的方式来命名:objectType[]或 byte[] buffer。