Java命名规范

末蓝、 2024-02-18 16:54 95阅读 0赞

## Java命名规范 ##

### 一、 一般概念 ###

#### 1、尽量使用完整的英文描述符 ####

#### 2、采用适用于相关领域的术语 ####

#### 3、采用大小写混合使名字可读 ####

#### 4、尽量少用缩写，但如果用了，必须符合整个工程中的统一定义 ####

#### 5、避免使用长的名字（小于 15 个字母为正常选择） ####

#### 6、避免使用类似的名字，或者仅仅是大小写不同的名字 ####

#### 7、避免使用下划线（除静态常量等） ####

### 二、 标识符类型说明 ###

#### 1、包（Package ）的命名 ####

Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名，通常是 com、edu、gov、mil、net、org 等；

如： com.yjhmily.test

#### 2、类（ Class ）的命名 ####

类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词，避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用，像 URL ， HTML)

如： FileDescription

#### 3、接口（ Interface ）的命名 ####

基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为”I”，便于与普通的 Class区别开。其实现类名称取接口名的第二个字母到最后，且满足类名的命名规范；

如： IMenuEngine

#### 4、枚举（ Enum ）的命名 ####

基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为”E”，便于与普通的 Class区别开。

如： EUserRole

#### 5、异常（ Exception ）的命名 ####

异常（ Exception ）通常采用字母 e 表示异常，对于自定义的异常类，其后缀必须为 Exception

如： BusinessException

#### 6、方法（ Method ）的命名 ####

方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头

如： getCurrentUser() 、 addUser() 、 hasAuthority()

#### 7、参数（ Param ）的命名 ####

第一个单词的首字母小写，其后单词的首字母大写。参数量名不允许以下划线或美元符号开头，虽然这在语法上是允许的。参数名应简短且富于描述。

如： public UserContext getLoginUser(String loginName);

#### 8、常量字段（ Constants ）的命名 ####

静态常量字段（ static final ）全部采用大写字母，单词之间用下划线分隔；

如： public static final Long FEEDBACK;

public static Long USER\_STATUS;

#### 9、变量名的命名 ####

小写字母开头，各个单词首字母大写，特有大写缩写词汇保持大写如：SQL

### 三、 其他 ###

#### 1. 页面文件命名 ####

采用全小写命名法

所有的字母均小写，单词之间以下划线’\_’分隔

展示页面，按照名词+描述，如：news\_list.jsp

操作页面，按照名词+动词命名，如：news\_add.jsp

按照模块从大到小命名，如：news\_order\_add.jsp

#### 2. 资源文件命名 ####

采用全小写命名法

按照前缀+模块+描述+状态命名，如：btn\_main\_login\_pressed.png

(不一定完全包含如上4个部分，但是要依照顺序命名)

### 四、 注释 ###

#### 1. 程序文件头注释 ####

应该包含如下：

\* 文件描述

\* 作者

\* 版本

\* 创建日期时间

\* 修改日期时间

提前设置好文件的模板Template

如以下模板：

<table> 
 <tbody> 
 <tr> 
 <td> /** &nbsp;* Description: &nbsp;* Author: KevinLee &nbsp;* Version: 1.0 &nbsp;* Create Date Time: ${DATE} ${TIME}. &nbsp;* Update Date Time: &nbsp;* / &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

#### 2. 方法头注释 ####

一般在写完一个方法后使用快捷键生成一个块注释，IDE会自动帮我们写入一些信息。

应该包含如下信息：

\* 方法描述 Description:

\* 参数信息 @param

\* 返回信息 @return

\* 异常信息 @Exception

\* 参考信息（可选）@see also //指定一个类或者方法（通过类后面加\#选择方法）

\* 笔记信息（可选）Note:

如以下模板：

<table> 
 <tbody> 
 <tr> 
 <td> /** &nbsp;* Description: 返回一个“Hello”字符串 &nbsp;* @param str 一个字符串 &nbsp;* @return 返回一个字符串 &nbsp;* @throws Exception&nbsp; 抛出一个异常 &nbsp;* @see com.lidengju.entity.Person &nbsp;* Note: Nothing much. &nbsp;*/ public&nbsp; String&nbsp; sayHello(String&nbsp; str) throws&nbsp; Exception{ &nbsp;&nbsp;&nbsp; str="Hello"; &nbsp; return&nbsp; str; } </td> 
 </tr> 
 </tbody> 
</table>

**注意：方法里面不要使用块注释**

#### 3. 关键点注释 ####

应该包含如下信息：

\* 一些程序关键的地方

\* 一些程序不易读的地方

\* 编写代码过程中遇到问题的地方

\* 需要提示读者的地方

注释应该写得少而易懂

若修改了文件，可以加上修改人的信息，和修改日期。