Java中的命名规则

在面向对象编程中，对于类，对象，方法，变量等方面的命名是非常有技巧的。比如，大小写的区分，使用不同字母开头等等。但究其本，追其源，在为一个资源定名称的时候，应该本着描述性以及唯一性这两大特征来命名，才能保证资源之间不冲突，并且每一个都便于记忆。

包的命名

Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
例如：net.frontfree.javagroup

类的命名

类的名字必须由大写字母开头而单词中的其他字母均为小写；如果类名称由多个单词组成，则每个单词的首字母均应为大写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。
例如：Circle

属性、方法的命名

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

常量的命名

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

参数的命名

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

接口的命名

接口名称都加上前缀“I”。

接口名称在前缀之后的部分命名规则与类相同。

根据接口类型可以在之后加上业务类型的头等。

例如：

IRunnable

ISingleton

变量的命名

总的来说，变量的命名与属性相似。

循环计数器
一般使用i、j和k来命名。

例外（Exception）
一般可以使用e,ex等来命名。

布尔变量（boolean）
可以使用bool***,***为有意义的英文单词或单词组合，如boolHaveRecord:是否有记录。

数组的定义

要用"int[] packets"，而不是"int packets[]"

List变量

可采取如下规则的命名规则，***List;

***为有意义的英文单词或单词组合，如dayList；

二维数组变量

可采取如下规则的命名规则，***Arr;

***为有意义的英文单词或单词组合，如lmtTypeArr；

某一数组或set的长度的命名

变量名称+Size如

packetsSize

常见分层及类名

action[控制层]：UserAction.java

model[数据模型层]：UserInfo.java

service[业务逻辑接口层]：IUserService.java

service.impl[业务逻辑实现层]：UserServiceImpl.java

service.dto[数据传输对象]：UserDTO.java

service.assembler[模型转换]：UserAssembler.java

dao[数据访问接口层]：IUserDao.java

dao.impl[数据访问实现层]：UserDaoImpl.java

api[API接口层]：IUserServiceApi.java

api.impl[API实现层]：UserServiceApiImpl.java

common[公共层]：***.java

Javadoc注释

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

/**
* This is an example of
* Javadoc
*
* @author ${USER}
* @version 0.1, 29/6/2021
*/

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

按照编程规范编写程序并且为程序添加良好的注释可以帮助你编写出设计完美，运行效率高且易于理解的程序，尤其是在多人合作完成同一项目时编程规范就变得更加重要。俗话说“磨刀不误砍柴工”，花费一点时间去适应一下Java编程规范是有好处的。