代码命名规范

---

前言

由于刚刚开始javaee的学习，很多方面的知识和规矩我都不了解。之前我的命名都是很随便的，这不利于别人理解以及项目的开发，接下来是一些命名规范的介绍。

---

1.java部分

1.杜绝完全不规范的缩写，避免望文不知义。

反例：AbstractClass“缩写”命名成AbsClass

诸如此类的随意缩写严重降低了代码的可阅读性。

2.代码中严禁使用拼音与英文混合的命名方式，更不允许直接使用中文命名的方式。正确的英文拼写和语法可以让阅读者易于理解，避免歧义。但是，即使是纯拼音命名方式，也要避免采用。

反例：getChengji(); int 变量1 = 1

3.方法命名时,其首字母应该小写，如果方法名由多个单词组成，则从第二个单词起，使用驼峰命名法进行书写。一般地，在对方法进行命名时，通常采用动词/动词+名词的组合，下面是方法命名的一些常见示例。

getUserName(); getHttpMessage()

4.常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

MAX_STOCK_COUNT

5.代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

反例：_name;$price

---

2.j2ee部分

1.servlet类所在包命名规范：公司名称.开发组名称.项目名称.web.servlet
例如：

net.linkcn.web.servlet

2.自定义标签类所在包命名规范：公司名称.开发组名称.项目名称.web.tags
例如：

net.linkcn.web.tags

3.过滤器类所在包命名规范：公司名称.开发组名称.项目名称.web.filter
例如：

net.linkcn.web.filter

4.Javabean所在包命名规范：公司名称.开发组名称.项目名称.web.struts.service.impl
例如：

net.linkcn.web.service.impl

5.Javabean实现接口命名规范：公司名称.开发组名称.项目名称.web.service
例如：

net.linkcn.web.service

6.POJO类与hbm文件所在包命名规范：公司名称.开发组名称.项目名称.dao.hbm
例如：

net.linkcn.dao.hbm

7.全局公共类、接口类所在包命名规范：公司名称.开发组名称.项目名称.global
例如：

net.linkcn.global

8.全局工具类所在包命名规范：公司名称.开发组名称.项目名称.util
例如：

net.linkcn.util