java编程规范

Posted 2020-10-25 jenny2015

* 包(Package) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的 Internet 域名反转并接上包名。 如: 
      java.awt 
     com.ambysoft.www.persistence 

* 类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。 如: 
      Customer 
     SavingsAccount 

* 接口(Interface) 采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er,但这不是必需的。如: 
      Contactable 
     Prompter 

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

* 异常(Exception) 通常采用字母 e 表示异常。 e 

* 类变量 字段采用完整的英文描述,第一个字母小写,任何中间单词的首字大写,如:   firstName 
      lastName 

* 实参/参数 同字段/属性的命名规则 
      public void setFirstName(String firstName){ 
            this.firstName = firstName; 
     } 

* 局部变量 同字段/属性的命名规则 

** 获取成员函数 被访问字段名的前面加上前缀 get。 getFirstName(), getLastName() 

    ** 布尔型的获取成员函数 所有的布尔型获取函数必须用单词 is 做前缀。 isPersistent(), isString() 

    ** 设置成员函数 被访问字段名的前面加上前缀 set。 setFirstName(), setLastName(),setWarpSpeed() 

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

    * 静态常量字段(static final) 全部采用大写字母,单词之间用下划线分隔。 MIN_BALANCE, DEFAULT_DATE 
    
    * 循环计数器 通常采用字母 i,j,k 或者 counter 都可以接受。 i, j, k, counter 

    * 数组 数组应该总是用下面的方式来命名: byte[] buffer;