一、 目的 6
二、 预期读者 6
三、 适用范围 6
四、 整体约束 6
五、 规范内容 7
1. 开发工具 7
2. 文件 7
2.1 文件后缀 7
2.2 常见文件名 8
3. 工程命名 8
4. 目录结构 9
4.1 编写目的 9
4.2 框架结构分层 9
4.3 逻辑结构分层 10
5. 命名规范 11
5.1 编写目的 11
5.2 规范细则 11
5.3 Package 包的命名 11
5.4 Class、Interface类、接口的命名 12
5.5 Methods方法的命名 12
5.6 Variables变量的命名 12
5.7 Constants常量的命名 13
5.8 变量定义规范 13
5.9 SQL编码规范 17
5.10 字符集规范 17
5.11 日志规范 17
6. 注释 18
6.1 编写目的 18
6.2 规范细则 19
7. 编程惯例 23
7.1 提供对实例以及类变量的访问控制 23
7.2 引用静态变量和静态方法 24
7.3 常量 24
7.4 变量赋值 24
7.5 其它惯例 25
7.6 Import包规范 26
7.7 长度规范 27
7.8 修饰关键字 27
7.9 代码块区域 28
7.10 一般的编码问题 29
8. 类设计问题 32
8.1 工具类(类仅仅包含静态的方法)定义为final类,私有其构造函数。 32
8.2 最小化类成员的可视性。 33
9. 其他规范 33
9.1 数组类型变量的声明。 33
9.2 源代码中避免使用 33
9.3 集合建议使用 33
9.4 实现java.io.Serializable接口的类,必须定义serialVersionUID(Eclipse可以生成)。 33
1