命名规范
背景
做项目,有一种良好的命名规范。那可是极重要的。
项目文件夹
- 包 :采用完整的英语描述,全小写字母组成,使用域名反转,如com.chen.action
- 配置文件文件夹:比如说,xml,properties等文件应该建包放在conf文件下,如果使用spring框架,可以存放在conf/spring下面,而不要都放在src文件夹下
文件命名
1. JSP/HTML:全小写命名,使用下划线进行标注。
例如:
形容词/量词+名词类:article_one.jsp
动词+名词类:manager_login.jsp
多名词类:大模块_小模块_操作.jsp
2. Servlet:最后不要加上Servlet,
例如:
名词+动词类:UserAdd.java
这样做,一方面文件按首字母排序的时候,对某些模块的各种操作就很清晰了,因为都连在一起了。
注解形式推荐使用user_add(@WebServlet("/user_add"))这样的形式,有一种RESTful的感觉。
3. Util:工具类、Dao:数据库类、Action:动作类等等:都一样,最后要加上类标志。
例如:
PictureUtil:图片工具。
UserDao:用户数据库操作。
变量
- 数组:加上s。如String[] users;
- 集合类:
Map<User> userMap
- 局部变量不使用缩写。
- 传递的变量使用全称。
华为编程规范
在此附上华为编程规范
下载地址