Java--命名规范

1. 命名规范

---

1.1 Java总体命名规范

• 项目名全部小写.
• 包名全部小写.
• 类名首字母大写,其余组成词首字母依次大写.
• 变量名,方法名首字母小写,如果名称由多个单词组成,除首字母外的每个单词的首字母都要大写.
• 常量名全部大写: 常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。 例如：MAX_VALUE
• 所有命名规则必须遵循以下规则 :
  • 名称只能由字母、数字、下划线、$符号组成.
  • 不能以数字开头.
  • 名称不能使用Java中的关键字.
  • 坚决不允许出现中文及拼音命名.

---

1.2 Java包名命名规范

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

---

1.2.1 常规包名

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

---

公司项目:

包名 : com.公司名.项目名.模块名…

团队项目:

包名 : team.团队名.项目名.模块名…

---

1.2.2 自定义包名

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

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

1.indi : 个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目。

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

2.pers : 个人项目,指个人发起,独自完成,可分享的项目。

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

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

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

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

包名 : onem .发起者名.项目名.模块名…

---

1.3 补充

• 【编码规范：推荐参考阿里巴巴开发手册编程规范】
  阿里巴巴开发手册

---

---