JAVA开发规范课件.ppt

修改记录注释的格式为: /** MODIFY BEGIN 修改人SVN账号，修改类型，日期 JAVA代码 …… MODIFY END */ /**MODIFY BEGIN guoqingwei,UPDATE,2011-09-28 JAVA代码 …… MODIFY END */ 1. 引言 2. 命名规范 3. 注释规范 4. 编码规范 基本规则 类编写规范 变量编写规范 方法编写规范 语言使用及书写规范 一个类文件最好不要超过２０００行 尽可能缩小对象的作用域，这样对象的可见范围和生存期也都会尽可能地小 一个方法所完成的功能要单一,不同的功能封装为不同的方法 尽可能的处理异常或转换异常，不要一味的包装异常 如果对象在某个特定范围内必须被清理（而不是作为垃圾被回收），请使用带有finally子句的try块，在finally子句中进行清理。 对于把一些逻辑相关的类组织在一起，可以考虑把一个类的定义放在另一个类的定义中，这种情况推荐使用内部类（比如界面层中的事件响应等）。内部类拥有所有外围类所有成员的访问权。 对成员变量的访问最好通过getter/setter方法,这样能够保证访问的合法性,以及代码调整 在处理可变String的时候要必须使用StringBuffer类，可变范围在５次以内可以使用String 使用java标准库提供的容器。精通他们的用法，将极大地提高工作效率。优先选择ArrayList来处理顺序结构，选择HashSet来处理集合，选择HashMap来处理关联数组，选择linkedList来处理堆栈和队列，它对顺序访问进行了优化，向List中间插入与删除的开销小，但随机访问则较慢。 类的组织结构，一般按照如下的顺序 常量声明 静态变量声明 成员变量声明 构造函数部分 Finalize部分 成员方法部分 静态方法部分 对成员变量, 尽量采用private 每一个变量声明/定义占一行（参数变量除外） 局部变量在使用前必须初始化，一般在声明时初始化 变量的声明要放在程序块的开始位置 int a ; int b; 对成员方法,不要轻易的采用public的成员变量。主要的修饰符有public, private, protected, 无 空方法中方法声明和函数体可都在一行。如：　void func(){} 方法和方法之间空一行 方法的文档注释放在方法的紧前面，不能空一行 避免过多的参数列表，尽量控制在５个以内，若需要传递多个参数时，当使用一个容纳这些参数的对象进行传递，以提高程序的可读性和可扩展性 方法中的循环嵌套不能超过２层 每个方法尽量代码行数尽量不要超过100行（有效代码行，不包括注释），但必须保证逻辑的完整性 方法与方法之间需要用一空行隔开 return语句中，不要有复杂的运算。 switch语句，需要一个缺省的分支 在与常数作比较时常数放在比较表达式的前面 If(“admin”.equals(userCode)){ …… } If(null == userCode){ …… } 谢谢！ ××× 2011-09-28 1. 引言 2. 命名规范 3. 注释规范 4. 编码规范 软件开发涉及到各方面人员的交互、协作，为了有效地进行项目开发的沟通，完善代码的维护和交付，有必要在项目开发中采用统一的软件开发标准。 无论从时间跨度还是从工作量来说，一个软件系统生存期的大部分是维护，不是开发。你今天所编写的代码，会一直使用很多年，并且很有可能被其他人维护和改进。所以，我们必须努力写出“干净”和易读的代码。 方便软件维护 据统计，80％的软件开发费用在维护，规范化的代码才方便维护，降低维护成本。 提高可读性 好的编码规范能够大大增强代码的可读性，便于开发人员快速的理解新代码。 保证软件质量 规范化的代码是软件质量的保证手段之一，也是软件过程能够流畅的基础。 1. 引言 2. 命名规范 3. 注释规范 4. 编码规范 基本命名规范 常量命名规范 变量命名规范 方法命名规范 包的命名规范 字符集在26个英文字母、0到9的阿拉伯数字和下划线之中 命名需要有一定的意义，推荐采用问题域中的术语命名 命名尽量的短，如果命名太长，可以采用别名的方式，或者缩写来简化命名 不要用前导下划线，也不要在命名的末尾用下划线 所有的字符都必须大写。采用有意义的单词组合表达，单词与单词之间以“_”下划线隔开。 命名尽量简短，不要超过16个字符 例如： public final int MAX_SIZE = 120;