Java程序编码规范
开发程序时,往往会有很多人参与,为了使程序的结构与代码风格标准化,以便于使每个参与开发的人员尽可能直观地查看和理解其它人编写的代码,需要在编码之前制定一套统一的编码规范。下面介绍一套Java语言中常用的程序编码规范供读者参考。
命名规则
数据类型简写规则
程序中定义常量、变量或方法等内容时,常常需要指定类型。下面介绍一种常见的数据类型简写规则,如表1所示。
变量及常量名称命名规则
根据不同的程序需要,编写代码时需要定义一定的变量或常量。下面介绍一种常见的变量及常量的命名规则。
变量:java中变量由单个或者多个单词组成,其中单个单词或多个单词的第一个单词所有字母小写,其余单词首字母大写,并且不能使用java中的关键字。例如:userName。变量的名称要有意义,能从变量名称中理解其含义。
常量:常量是在程序运行过程中值不能改变的量。常量也要使用有意义的名称,并且单词的所有字母要大写,如果由多个单词组成,就使用下划线分割。例如USER_NAME。
类命名规则
使用完整的单词,避免使用缩写。
类名称的首字母要大写。
尽量使用名称。类通常表示一种对象类型,而对象一般使用具有名词性质的名称。
不要使用$或者下划线作为前缀。尽管在Visual Basic 和Visual C++等其它语言中,这是非常普遍的,但在java中不提倡使用。
自定义异常类命名通常要以Exception结尾,但应该尽量避免自定义异常类。
避免将多个类放在一个文件里。
初始化类的实例时,除非非常必要,否则不要赋值为null。
成员变量命名规则
成员变量名称通常都是名词,命名规则与变量相同。例如name和age等。
成员变量名称不能与java关键字相同。
尽量不要提供public和protected的成员变量,使用设置器和访问器操作它们。
方法命名规则
方法名通常都是动词,因为方法用来实现一个对象的行为功能,例如read()、write()、start()和stop()等。
当重载方法是,参数的顺序和声明时的参数顺序要一致。