java开发规范与基本原则(pdf 37页)

目录
第1章 绪论..................5
1.1 目的..................5
1.2 范围..................5
1.3 版权声明..................5
1.4 参考资料..................5
1.5 概述..................5
第2章 代码组织与风格................7
2.1 基本原则..................7
2.2 缩进..................7
2.3 长度..................7
2.4 行宽..................7
2.5 间隔..................7
2.6 对齐..................7
2.7 括号..................8
第3章 注释..................9
3.1 基本原则..................9
3.2 JAVADOC..................9
3.3 文件与包注释................9
3.4 类、接口注释................10
3.5 方法注释..................10
3.6 其他注释..................11
3.7 注释参考表................11
第4章 命名..................13
4.1 基本原则..................13
4.2 文件、包..................13
4.3 类、接口..................13
4.4 字段..................14
4.5 方法..................14
4.6 异常..................15
4.7 命名约定表................15
第5章 声明..................17
5.1 基本原则..................17
5.2 包..................17
5.3 类、接口..................17
5.4 方法..................17
5.5 字段..................18
5.6 示例..................18
第6章 类与接口................20
6.1 基本原则..................20
6.2 抽象类与接口................20
6.3 继承与组合................20
6.4 构造函数和静态工厂方法...............20
6.5 TOSTRING(),EQUALS(),HASHCODE()............20
6.6 SINGLETON CLASS...............22
第7章 方法..................23
7.1 基本原则..................23
7.2 参数和返回值................23
第8章 表达式与语句................24
8.1 基本原则..................24
8.2 控制语句..................24
8.3 循环语句..................25
第9章 错误与异常................26
9.1 基本原则..................26
9.2 已检查异常与运行时异常...............26
9.3 异常的捕捉与处理................26
第10章 测试与BUG跟踪................27
10.1 基本原则................27
10.2 测试驱动开发................27
10.3 JUNIT单元测试................27
10.4 自动测试与持续集成...............27
10.5 BUG跟踪和缺陷处理...............27
第11章 性能与安全................28
11.1 基本原则................28
11.2 STRING与STRINGBUGFFER...............28
11.3 集合..................28
11.4 对象..................28
11.5 同步..................28
11.6 FINAL..................28
11.7 垃圾收集和资源释放...............29
第12章 其他..................30
12.1 目录结构................30
12.2 CVS注释与标记................31
12.3...................31
第13章 附录..................32
13.1 CVS标识符................32
13.2 注释模板................32
13.3 常用缩写简表................33
13.4 版权声明模板................33
13.5 示例代码................34

 

第1章 绪论
1.1 目的
本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。
1.2 范围
本规范适用于“Skyinn Group”及其下所有软件项目、产品等的设计、开发以及维护、升级等。
本规范使用于“Skyinn Group”的所有软件开发人员，在整个软件开发过程中必须遵循此规范。
1.3 版权声明
本文档为共享文档，不限转载，但请保持本文档的完整性。
您可以修改本文档以符合您或组织、公司等之实际，但请在文档中保持对本文档的引用和说明。
未经本人授权，任何个人、组织或单位不得将本文档用于书面发表、转载、摘录等，亦不得用于其他商业行为。
本人及本组织不承担任何因使用、参考本文档等而导致的任何可能责任或连带责任。

..............................