一、包的命名
- 一个小写单词,包名的前缀总是一个顶级域名
- import包的时候,不要使用通配符
二、类的命名:
- 采取“大驼峰”的命名规则。即每个单词的第一个字母大写。
- 名字必须简洁明了
- 对于controller、service、dao,类的名称应以包的后缀作为结尾
三、变量规范
- 变量采取“小驼峰”的命名规则。即除第一个单词外,每一个单词的第一个字母大写
- 当变量名字过长(一般为超出16位)时,将其中一个或多个单词缩写至前6位或能表明其含义的任意位置
- 不要使用组合声明,比如int a, b;
- 静态成员:使用类进行调用
四、方法以及接口的命名
- 方法采取“小驼峰”的命名规则
- 方法名过长时,可适当采取类似变量命名规则的缩写样式
- default的情况要写出来
- 异常后缀必须为 Exception
- 异常要捕获,作出响应
- 接口采取“小驼峰”的命名规则
- 跳转页面类接口,采取to+xxx样式
- 创建或对数据进行添加操作的接口,采取add+xxx样式
- 编辑或对数据进行修改操作的接口,采取edit+xxx样式
五、JSP包及文件的命名
- JSP包采取pages_xxx的命名规则,其中xxx为按照前端逻辑对页面进行的分类名称
- JSP文件采取全部小写,中间以下划线分隔的命名规则
六、注释
- 块注释与其周围的代码在同一缩进级别。它们可以是/* ... /风格,也可以是// …风格。对于多行的/ ... /注释,后续行必须从开始, 并且与前一行的*对齐。以下示例注释都是OK的。
其他方面
- List及其他相似类的对象命名采用其内部存储的类型名字(基本类型除外)
- JSP文件中c:foreach语句的循环变量统一用一个名字来命名
- Hibernate 映射文件及实体 与数据库表名称完全对应; 如: Advertisement.hbm.xml 、 Advertisement.java