Java命名规则

Java命名规则

-,$不作为变量名，方法名开头。变量名，方法名首单词小写，其余单词只有首字母大写，例如，anyVariableWorld。接口名，类名首单词第一个字母大写。常量完全大写。

1、包的命名规则

       包名采用完整的英文描述符，应该都是有小写字母组成，对于全局包，可以将所在公司Internet域名反转再接上包名，例如com.bme.tools。

2、类与接口的命名规则

       类名与接口名都采用英文描述符，并且所有单词的第一个字母大写，例如Customer，SavingsAccount。另外接口名后面可以加上后缀able,ible或er，但这不是必需的，例如Contactable,Prompter。

3、变量的命名规则

(1)类的属性，采用完整的英文描述符，第一个字母小写，任何中间单词的首字母大写，例如firstName,lastName。

(2)方法的参数，类似如类的属性。

(3)局部变量，类似如类的属性。

(4)变量命名的一些习惯，异常：通常采用字母e表示异常；循环计数器：通常采用字母i,j,k或者counter。

4、常量或静态常量的命名规则

       常量名全部采用大写字母，单词之间用下划线分隔，例如MIN_NUMBER。

5、方法的命名规则

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

    Java注释规则

1、 三类注释的使用

(1)文档注释 /**    */，文档注释被javadoc处理，可以建立类的一个外部说明性文件。在接口，类，类的属性，类的成员方法声明前应该加上文档注释，对这些定义的含义、功能等进行说明。

(2)C语言风格注释 /*     */，采用C语言风格的注释在程序中注释掉一行或多行的代码段。这种方式可以用于去掉当前不再使用，但扔想保留的代码或进行条件编译标记。

(3)单行注释//，在成员方法内才用单行注释，说明代码段的业务逻辑、临时变量的声明等。格式上一般为注释符“//”后紧跟一个空格，然后才是注释信息。

2、 注释的使用原则

(1)    类注释，类的功能和用途，类的开发和维护历史。

(2)    接口注释，接口的用途，使用环境与使用方法。

(3)    属性注释，属性的描述，如果属性的访问权限不是私有的，应该在注释中适当说明理由。

(4)    成员方法注释

A．成员方法基本注释

成员方法的功能，成员方法参数说明，成员方法返回值说明，已只漏洞，成员方法抛出的异常，成员方法访问权限说明，正确引用成员方法的例子，多线程并发控制进行说明。

       B．成员方法内部注释

       控制结构，关键代码的逻辑说明，局部变量说明，难懂或复杂代码的注释，处理顺序，注释结束符号(// end if等)。

    编程建议

1、 成员方法的30秒原则

成员方法的30秒原则是指：其他编程人员应该能够在阅读你的成员方法30秒内，就能完全理解它是做说明的，为说明这么做，以及如何去做。

2、 最小化公共和受保护的接口

尽量减少类中公共和受保护的接口，是面向对象设计的基本原则之一。这个原则的好处就是，易学，减少耦合，更大的适用。

3、 提高程序性能

(1)    不要在循环体中创建和释放对象

(2)    适用StringBuffer对象处理字符串问题。

(3)    避免太多地使用synchronized关键词

(4)    不要使用System.out.println()语句进行调试和打印信息，你有可能忘记删除该语句，该语句会影响系统性能。