Java 命名规范

一、Java总体命名规范

1、项目名全部小写.

2、包名全部小写.

3、接口和类名首字母大写,其余组成词首字母依次大写，如：类名 LoginFrame.

4、变量名,方法名首字母小写,如果名称由多个单词组成,除首字母外的每个单词的首字母都要大写.

5、常量名全部大写.

6、Java的关键字都是小写

7、所有命名规则必须遵循以下规则 :

名称只能由字母、数字、下划线、$符号组成.
不能以数字开头.
名称不能使用Java中的关键字.
坚决不允许出现中文及拼音命名.

二、Java包名命名规范

Java的包名由小写单词组成,包的路径符合所开发的系统模块的定义,以便通过包名可得知其属于哪个模块,从而方便到对应包里找相应的实现类.

1、常规包名

为了保障每个Java Package命名的唯一性,在Java编程规范中要求开发人员在自己定义的包名前加上唯一的前缀.由于互联网上的域名称是不会重复的,所以多数开发人员采用自己公司在互联网上的域名称作为自己程序包的唯一前缀.例如 : com.sun.swt...

1.公司项目
com : 公司项目,copyright由项目发起的公司所有.
包名 : com.公司名.项目名.模块名..

2.团队项目
team : 团队项目,指由团队发起,并由该团队开发的项目,copyright属于该团队所有.
包名 : team.团队名.项目名.模块名..

2、自定义包名

一般公司命名为com.公司名.项目名.模块名....那我们个人的项目又怎么命名呢?

个人的英语单词有individual、personal、private、one-man,进一步对以上四个单词词意进行分析并在保证了唯一性,继而使用每个单词的前4个字母作为前缀,与com也做了区分.示例如下所示:

1.indi : 个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,copyright主要属于发起者.

包名 : indi.发起者名.项目名.模块名..

2.pers : 个人项目,指个人发起,独自完成,可分享的项目,copyright主要属于个人.

包名 : pers.个人名.项目名.模块名..

3.priv : 私有项目,指个人发起,独自完成,非公开的私人使用的项目,copyright属于个人.

包名 : priv.个人名.项目名.模块名..

4.onem : 与indi相同，推荐使用indi.

三、注释规范

1、类注释

在每个类前面必须加上类注释，注释模板如下：

/**

• Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

• FileName: Test.java

* 类的详细说明

• @author 类创建者姓名
      * @Date    创建日期

• @version 1.00

*/

2、属性注释

在每个属性前面必须加上属性注释，注释模板如下：

/** 提示信息 */

private String strMsg = null;

3、方法注释

在每个方法前面必须加上方法注释，注释模板如下：

/**

* 类方法的详细使用说明

• @param 参数1 参数1的使用说明

• @return 返回结果的说明

• @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

4、构造方法注释

在每个构造方法前面必须加上注释，注释模板如下：

/**

* 构造方法的详细使用说明

• @param 参数1 参数1的使用说明

• @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

5、方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。

如：//背景颜色

Color bgColor = Color.RED

6、项目分层命名

一般可以分为两种情况进行命名：

A、以功能模块来分层定义

比如，现有两个功能模块User、Menu

com.xxx.user.action        com.xxx.menu.action

com.xxx.user.service      com.xxx.menu.service

com.xxx.user.dao            com.xxx.user.dao

com.xxx.user.controller   com.xxx.user.controller

B、以逻辑模块来划分

com.xxx.action  UserAction  MenuAction

com.xxx.service  UserService  MenuService