Java 命名规范

Java命名规范

定义规范的目的是为了使项目的代码样式统一，使程序有良好的可读性。

包的命名　 （所有小写，由域名定义）

Java包的名字都是由小写单词组成。可是因为Java面向对象编程的特性，每一名Java程序员都 能够编写属于本身的Java包，为了保障每一个Java包命名的惟一性，在最新的Java编程规范中，要求程序员在本身定义的包的名称以前加上惟一的前缀。 因为互联网上的域名称是不会重复的，因此程序员通常采用本身在互联网上的域名称做为本身程序包的惟一前缀。 
例如：net.frontfree.javagroup

类的命名 （单词首字母大写）

根据约定，Java类名一般以大写字母开头，若是类名称由多个单词组成，则每一个单词的首字母均应为大 写例如TestPage；若是类名称中包含单词缩写，则这个所写词的每一个字母均应大写，如：XMLExample,还有一点命名技巧就是因为类是设计用来 表明对象的，因此在命名类时应尽可能选择名词。 　　 
例如： Graphics

方法的命名 （首字母小写，字母开头大写）

方法的名字的第一个单词应以小写字母做为开头，后面的单词则用大写字母开头。 
例如：drawImage

常量的命名 （所有大写 ，常加下划线）
常量的名字应该都使用大写字母，而且指出该常量完整含义。若是一个常量名称由多个单词组成，则应该用下划线来分割这些单词。 
例如：MAX_VALUE

参数的命名

参数的命名规范和方法的命名规范相同，并且为了不阅读程序时形成迷惑，请在尽可能保证参数名称为一个单词的状况下使参数的命名尽量明确。

Javadoc注释

Java除了能够采用咱们常见的注释方式以外，Java语言规范还定义了一种特殊的注释，也就是咱们 所说的Javadoc注释，它是用来记录咱们代码中的API的。Javadoc注释是一种多行注释，以/**开头，而以*/结束，注释能够包含一些 HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释能够被自动转为在线文档，省去了单独编写程序文档的麻烦。 
例如：

/** 
* This is an example of 
* Javadoc 
* @author darchon 
* @version 0.1, 10/11/2002 
*/

在每一个程序的最开始部分，通常都用Javadoc注释对程序的整体描述以及版权信息，以后在主程序中 能够为每一个类、接口、方法、字段添加 Javadoc注释，每一个注释的开头部分先用一句话归纳该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其归纳做用，在这句话后面能够跟 随更加详细的描述段落。在描述性段落以后还能够跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这 些段落将在生成文档中以特定方式显示。

变量和常量命名

变量的命名

主要的的命名规范有如下三种：
Camel 标记法:首字母是小写的,接下来的单词都以大写字母开头
Pascal 标记法:首字母是大写的,接下来的单词都以大写字母开头
匈牙利标记法:在以Pascal标记法的变量前附加小写序列说明该变量的类型

在Java咱们通常使用匈牙利标记法，基本结构为scope_typeVariableName，它 使用1-3字符前缀来表示数据类型，3个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，并且每一个单词的首写字母大写，其它字 母小写，这样保证了对变量名可以进行正确的断句。例如，定义一个整形变量，用来记录文档数量：intDocCount，其中int代表数据类型，后面为表 意的英文名，每一个单词首字母大写。这样，在一个变量名就能够反映出变量类型和变量所存储的值的意义两方面内容，这使得代码语句可读性强、更加容易理解。 byte、int、char、long、float、 double、boolean和short。

数据类型/前缀(附)
byte b
char c
short sh
int i
long l
char c
string s
float f
double d
hashtable h
[] arr
List lst
Vector v
StringBuffer sb
Boolean b
Byte bt
Map map
Object ob

对于在多个函数内都要使用的全局变量，在前面再增长“g_”。例如一个全局的字符串变量：g_strUserInfo。

在变量命名时要注意如下几点：

· 选择有意义的名字，注意每一个单词首字母要大写。

· 在一段函数中不使用同一个变量表示先后意义不一样的两个数值。

· i、j、k等只做为小型循环的循环索引变量。

· 避免用Flag来命名状态变量。

· 用Is来命名逻辑变量，如：blnFileIsFound。经过这种给布尔变量确定形式的命名方式，使得其它开发人员可以更为清楚的理解布尔变量所表明的意义。

· 若是须要的话，在变量最后附加计算限定词，如：curSalesSum。

· 命名不相包含，curSales和curSalesSum。

· static final 变量(常量)的名字应该都大写，而且指出完整含义。

· 若是须要对变量名进行缩写时，必定要注意整个代码中缩写规则的一致性。例如，若是在代码的某些区域中使用intCnt，而在另外一些区域中又使用intCount，就会给代码增长没必要要的复杂性。建议变量名中尽可能不要出现缩写。

· 经过在结尾处放置一个量词，就可建立更加统一的变量，它们更容易理解，也更容易搜索。例如，请使用 strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。常 用的量词后缀有：First（一组变量中的第一个）、Last（一组变量中的最后一个）、Next（一组变量中的下一个变量）、Prev（一组变量中的上 一个）、Cur（一组变量中的当前变量）。

· 为每一个变量选择最佳的数据类型，这样即能减小对内存的需求量，加快代码的执行速度，又会下降出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种状况下，编译器不会产生运行期错误，它只是迫使该值符合数据类型的要求。这类问题极难查找。

· 尽可能缩小变量的做用域。若是变量的做用域大于它应有的范围，变量可继续存在，而且在再也不须要该变量后的很长时间内仍然占用资源。它们的主要问题是，任何类 中的任何方法都能对它们进行修改，而且很难跟踪到底是何处进行修改的。占用资源是做用域涉及的一个重要问题。对变量来讲，尽可能缩小做用域将会对应用程序的 可靠性产生巨大的影响。

关于常量的命名方法，在JAVA代码中，不管何时，均提倡应用常量取代数字、固定字符串。也就是 说，程序中除0，1之外，尽可能不该该出现其余数字。常量能够集中在程序开始部分定义或者更宽的做用域内，名字应该都使用大写字母，而且指出该常量完整含 义。若是一个常量名称由多个单词组成，则应该用下划线“_”来分割这些单词如：NUM_DAYS_IN_WEEK、MAX_VALUE。