JAVA开的发规则规范.ppt

4. 编码规范 基本规则 类编写规范 变量编写规范 方法编写规范 语言使用及书写规范 Java 开发规范 目录 1. 引言 2. 命名规范 3. 注释规范 4. 编码规范 1. 引言-综述 软件开发涉及到各方面人员的交互、协作，为了有效地进行项目开发的沟通，完善代码的维护和交付，有必要在项目开发中采用统一的软件开发标准。 无论从时间跨度还是从工作量来说，一个软件系统生存期的大部分是维护，不是开发。你今天所编写的代码，会一直使用很多年，并且很有可能被其他人维护和改进。所以，我们必须努力写出“干净”和易读的代码。 1. 引言-好处 方便软件维护 据统计，80％的软件开发费用在维护，规范化的代码才方便维护，降低维护成本。 提高可读性 好的编码规范能够大大增强代码的可读性，便于开发人员快速的理解新代码。 保证软件质量 规范化的代码是软件质量的保证手段之一，也是软件过程能够流畅的基础。 目录 1. 引言 2. 命名规范 3. 注释规范 4. 编码规范 2. 命名规范 基本命名规范 常量命名规范 变量命名规范 方法命名规范 包的命名规范 2. 命名规范-基本命名规范 字符集在26个英文字母、0到9的阿拉伯数字和下划线之中 命名需要有一定的意义，推荐采用问题域中的术语命名 命名尽量的短，如果命名太长，可以采用别名的方式，或者缩写来简化命名 不要用前导下划线，也不要在命名的末尾用下划线 所有的字符都必须大写。采用有意义的单词组合表达，单词与单词之间以“_”下划线隔开。 命名尽量简短，不要超过16个字符 例如： public final int MAX_SIZE = 120; public final int MAX_WIDTH = 100; public final String PROPERTY_NAME= menu ; 2. 命名规范-变量命名规范 避免在命名中采用数字，除非有其他特殊含义 变量名称是名词意义 第一个单词全部小写，后续的每个单词采用首字母大写，其余小写 命名尽量简短，不要超过16个字符 除了生命周期很短的临时变量外，避免采用单字符作为变量名 在某些情况下，变量可能需要加上类型前缀（后缀），前缀（后缀）与变量名称的实体部分没有任何间隔 例如： public String strName; List userList = new ArrayList(); Button submitBtn = new Button(); 2. 命名规范-方法命名规范 命名多数为动词结构 第一个单词采用小写，后续的每个单词采用首字母大写，其余小写，没有特别理由不用下划线作为分隔符 构造方法的命名与类名一致 在Java中对属性方法命名遵循JavaBean的标准： getter方法：get+属性名, 对boolean型采用is+属性名，有些特定的属性名用has, can代替is可能更好 setter方法：set+属性名 String getName(); boolean isStopped(); boolean hasChild(); JSP目录规范 目录 说明 common 公共资源（包括公共jsp，公共js组件，部门公共js等等） pages 应用的页面文件目录 pages/power 应用的power模块的页面文件目录 pages/js 公共脚本 styles 页面样式文件目录 WEB-INF Web应用系统部分，包括配置文件、库文件、类文件等 widgets WEB组件目录 JAVA目录规范 包名 说明 **.common 公共类文件目录 **.common.constants 公共常量静态类目录 **.common.filter 公共过滤器目录 **.common.util 公共工具类目录 **.common. servlet 公共servlet类目录 **. model POJO对象目录 **.facade 接口目录 **. spring Spring方式实现目录 **. vo 自定义VO类 **. web Struts2方式的Action目录 目录 1. 引言 2. 命名规范 3. 注释规范 4. 编码规范 3. 注释规范 基本规范 三种注释方式说明 变量注释 方法注释 算法注释 修改记录 3. 注释规范-基本规范 注释应该使代码更加清晰易懂 注释要简单明了，只要提供能够明确理解程序所必要的信息就可以了 注释不仅描述程序做了什么， 还要描述为什么要这样做,以及约束