Java编程规范
JAVA编程规范的作用和意义:
JAVA程序员能够依据JAVA编程规范养成良好的编程习惯,是编写良好JAVA程序的先决条件。对于JAVA编程规范首先要准确理解。例如,每行声明一个局部变量,不仅仅要知道是JAVA编程规范的要求,更重要的是要理解这样增加了代码的易懂性。理解好JAVA编程规范是发挥规范作用的基础。理解规范中每个个原则仅仅是开始,进一步需要相信这些规范是编码的最好方法,并且在编程过程中坚持应用。另外,应该在编程过程中坚持一贯遵循这些规范,培养成习惯,这样能够保证开发出干净代码(Clean code),使开发和维护工作更简单。从一开始就写干净的代码,可以在程序开发过程中以及程序维护阶段不断受益。
本文介绍JAVA编程规范主要包括JAVA命名约定、JAVA注释规则、JAVA源文件结构规则、JAVA源代码排版规则,以及更深入的编程建议。
JAVA命名约定
JAVA中标识符尽量使用完整的英文描述符及适用于相关领域的术语。为了增加标识符的可读性,形式上采用大小写混合方式。标识符的长度虽然没有限定,但应尽量避免使用和的名字,一般不少于15个字母。另外要少用或慎用缩写,如果使用则要保证在整个应用程序中风格统一。要避免使用拼写类似的标识符,或者仅仅是大小写不同的标识符,并且除静态常量名称外,应避免使用下划线。
JAVA中的名称包括包(package)名、类(class)名、接口(interface)、变量名、方法名、常数名。JAVA对于这些名称命名的约定的基本原则如下:
1、_,$不作为变量名,方法名开头
2、变量名、方法名首单词小写,其余单词只有首字母大写,例如 anyVariableWorld
3、接口名、类名首单词第一个字母大写,
4、常量完全大写
1.包的命名规则
包名采用完整的英文描述符,应该都是由小定字母组成。对于全局包,可以将所在公司Internet域名反转再接上包名,例如com.taranis.graphics。
2.类和接口命名规则
类名和接口名采用完整的英文描述符,并且所有的单词第一个字母大写,例如例如Customer,SavingsAccount.另外接口后面可以加上后缀able,ible或者er,但这不是必需的,例如Contactable,Prompter
3.变量的命名规则
(1)类的属性(变量)
采用完整的英文描述符,第一个字母小写,任何中间单词的首字母大写,例如firstName,lastName
(2)方法的参数
方法参数的命名规则与属性的命名规则相同,例如public void setFirstName(String fristName) {this.firstName = firstName;}
(3) 局部变量
局部变量的命名规则与属性的命名规则相同。
(4)变量命名的某些习惯
异常(exception):通常采用字母e表示异常。
循环计数器:通常采用字母i,j,k或者counter
4.常量或静态常量(static final)
常量名全部采用大写字母,单词之间用下划线分隔,例如MIN_BALANCE,DEFAULT_DATE。
5.方法的命名规则
(1)普通成员方法
采用完整的英文描述说明成员方法功能,第一个单词要采用一个生动的动词,第一个字母小写,例如openFile(),addAccount()
(2)属性存取器方法
属性存取器是类中对某个私有属性值进行读、写的方法。对于读取属性值的方法称为属性获取方法,而对于属性赋值的方法称为属性设置方法。
属性获取方法的命名
采用访问属性名的前面加前缀get,如getFirstName(),getLastName().所有布尔型获取方法必须用单词is做前缀。例如isPersistent(), isString();
属性设置方法的命名
被访问字段名的前面加上前缀set。例如setFirstName(),setLastName(),setWarpSpeed().
6.组件(component)的命名规则
组件使用完整的英文描述来说明组件的用途,末端应接上组件类型,例如canceButton,customerList,fileMenu.