电信事业部Java编程规范.doc

电信事业部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.6 Final变量（常量）的命名 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.4 switch-case语句 20 7.5 try-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.1 FATAL级别的例外： 24 12.1.2 其他级别的例外： 24 12.1.3 释放资源统一在final里面做. 24 12.2 错误日志处理： 24 12.2.1 FATAL级别： 24 12.2.2 ERROR级别： 24 12.2.3 WARN级别： 24 12.2.4 INFO级别： 24 12.2.5 DEBUG级别： 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、如何提高代码的严谨性、可靠性和提高质量等方方面面的内容，需要每一个开发人员在每天的工作中严格遵守。 目的 提高编码工作的规范性 提高完成的代码的规范性 避免编写多余、低效、漏洞百出的代码 加强开发人员的技术素养、提高开发工作的质量 范围 这个文档的范围包括： 一个源代码文件的内容，应该怎样组织，风格怎样 代码中注释的位置、写法、要求 包、类、方法、常量、变量、属性等的命名的要求 声明的编写要求 表达式的编写要求 内存管理方面的要求 异常处理方面的要求 针对可移植性的编程要求 针对复用的编程要求 这些要求对于提高代码质量、提高代码的规范性有帮助，定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为人员变更而带来的损失。 这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性，需要各开发同事努力遵守。 定义、首字母缩写词和缩略语 [本小节应提供正确理解此编程指南所需的全部术语、首字母缩写词