android电信营业厅java源码,电信事业部Java编程规范汇编.doc

电信事业部Java编程规范汇编

电信事业部Java项目

编程规范

版本 <1.0>

修订历史记录

日期版本说明作者<27日/10月/2008年><0.6>初步拟定田标<1日/11月/2008年><0.8>杨济嘉<10日/11月/2008年><0.8>补充错误处理和异常处理事件部分的内容田标

目录

1.简介6

1.1目的6

1.2范围6

1.3定义、首字母缩写词和缩略语6

1.4参考资料6

1.5概述6

2.代码组织与风格7

2.1开头注释7

2.2包和引入语句7

2.3类的注释7

2.4类声明7

2.5类的成员变量7

2.6构造函数8

2.7类方法8

2.8关于代码组织与风格的推荐示例9

3.缩进排版16

3.1行长度16

3.2换行16

4.注释16

4.1类的注释16

4.2方法的注释17

4.3类属性的注释17

4.4非JavaDoc的注释18

5.命名18

5.1包的命名18

5.2类的命名18

5.3接口的命名18

5.4方法的命名18

5.5变量的命名18

5.6Final变量(常量)的命名18

5.7参数的命名18

6.声明18

6.1每行声明变量的数量18

6.2初始化18

6.3避免覆盖18

6.4数组的声明18

6.5类和接口的声明19

7.表达式和语句19

7.1简单语句19

7.2复合语句19

7.3选择和循环语句19

7.4switch-case语句20

7.5try-catch/try-catch-finally语句20

8.空白20

8.1空行21

8.2空格21

9.设计类和方法21

9.1创建具有很强内聚力的类21

9.2创建松散连接和高度专用的方法21

9.2.1使所有方法都执行专门的任务21

9.2.2尽量使方法成为自成一体的独立方法22

9.2.3设计类和方法时，要达到下列目的22

9.3编程原则22

9.3.1为方法和类赋予表义性强的名字22

9.3.2为每个方法赋予单个退出点23

9.3.3创建方法时，始终都应显式地定义它的作用域。23

9.3.4用参数在方法之间传递数据23

10.一些编程惯例23

10.1提供对实例以及类变量的访问控制23

10.2引用类变量和类方法23

10.3常量23

10.4变量赋值23

10.5圆括号23

11.内存管理23

12.错误处理和异常事件23

12.1错误捕获方式：24

12.1.1FATAL级别的例外：24

12.1.2其他级别的例外：24

12.1.3释放资源统一在final里面做.24

12.2错误日志处理：24

12.2.1FATAL级别：24

12.2.2ERROR级别：24

12.2.3WARN级别：24

12.2.4INFO级别：24

12.2.5DEBUG级别：24

13.可移植性24

14.复用25

15.涉及到代码质量的问题25

15.1制造多余代码25

15.2质量上有缺陷的代码26

15.3很多小技巧31

15.4致命的问题34

16.编译问题35

17.附录：指南概要35

Java项目编程指南

简介

此编程指南的文档用来规范每一个一线开发人员代码的编写，试图确保代码编写的规范化和代码编写的质量，进而提高我们开发的项目的质量和开发团队的编码水平。

此编程指南的内容涵盖了从源代码文件的结构、格式，对常见代码要素的格式和内容两个方面的要求，到如何避免长犯的错误，避免bug、如何提高代码的严谨性、可靠性和提高质量等方方面面的内容，需要每一个开发人员在每天的工作中严格遵守。

目的

提高编码工作的规范性

提高完成的代码的规范性

避免编写多余、低效、漏洞百出的代码

加强开发人员的技术素养、提高开发工作的质量

范围

这个文档的范围包括：

一个源代码文件的内容，应该怎样组织，风格怎样

代码中注释的位置、写法、要求

包、类、方法、常量、变量、属性等的命名的要求

声明的编写要求

表达式的编写要求

内存管理方面的要求

异常处理方面的要求

针对可移植性的编程要求

针对复用的编程要求

这些要求对于提高代码质量、提高代码的规范性有帮助，定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为人员变更而带来的损失。

这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性，需要各开发同事努力遵守。

定义、首字母缩写词和缩略语

[本小