开发编码规范.docxVIP

JAVA编码规范vl.O 目录 TOC \o 1-5 \h \z \o Current Document 关于 3 \o Current Document 项目结构 3 2.1命名空间 3 2.2源文件 3 2.3文件目录存放 3 \o Current Document 命名约定 4 排版 5 \o Current Document Java文件格式 6 \o Current Document 注释规范 6 \o Current Document 代码编译 8 性能 8 \o Current Document 测试及维护 9 \o Current Document 异常 9 \o Current Document 编程技巧 10 1） 使用 StringBuffer 对象 10 2） 避免太多的使用 synchronized 关键字 10 3） 避免使用 java.util.Vector 类 10 4） 面向接口编程 10 5） 避免使用索引来调用数据库中间层组件返回的结果集 11 6） 对于自己创建的每一个类，都考虑置入一个 main（） 11 7） 应将方法设计成简要的、功能性单元 11 8） 设计一个类时，请设身处地为客户程序员考虑一下 11 9） 使类尽可能短小精悍，而且只解决一个特定的问题。 12 10） 采用内部类 12 11） 采用注释 12 12） 避免使用魔术数字 12 13） 接口和抽象类的使用 12 14） 日志调试 13 \o Current Document JSP编码规范 13 \o Current Document 日志框架 14 \o Current Document 事务处理 16 关于 本文档以JAVA编程语言为基础，提供编码规范的指导，以统一开发人员的 书写标准，提高代码的可读性。 代码体系、接口规约、命名规则等，这是项目小组今后共同作战的基础，有 了编码规范和程序模块之间和项目成员彼此之间的接口规则、 方式方法，大家就 有了共同的工作语言、共同的工作平台，使整个软件开发工作可以协调有序地进 行。 项目结构 2.1命名空间 每个命名空间对应一个目录。采用完整的英文描述符，应该都是由小写字母 组成。对于全局,将你的In ternet域名反转并接上包名如 java.awt,com.ambysoft.www.persistenee。全局命名空间下的其它则按照功 能进行划分，每个功能包下则按照放置的不同文件性质进行设置。 2.2源文件 以类名作为文件名。一个文件只应该有一个命名空间，避免将多个类或命名 空间放在同一个文件里面：一个文件除去 IDE产生的代码后最好不要超过 500行的代码，一个方法的代码长度最好不要超过 25行，超出后应考虑拆 分代码或重构以降低耦合；每行代码不要超过80个字符;避免方法中有超过5 个参数的情况。如果超过了 ，则应将参数封装为类或集合类型进行传递。 2.3文件目录存放 JSP存放目录按子系统存放，同一子系统中的JSP文件不再分设单独的目录。 图片存放目录为” /images ” ，JS文件存放目录为：专用的JS文件和jsp文 件在同一目录下，公用的放在” /js ”下；所有的样式表都存放在” /css ”下； 子系统目录采用完整的英文描述说明，第一个单词的首字母小写，其他单词 首字母大写 命名约定 命名方式 使用匈牙利表示法，命名时应始终采用完整的英文描述符，一般应采用 小写字母。 命名规则 ）包的命名 包的命名一般都有小写字母组成。 如 package com.util ）类的命名 类的名字必须由大写字母开头而其他字母都小写的单词组成，其中包含 的所有单词都应紧靠在一起，而且大写中间单词的首字母。 如 Public class UserService{} 3）类的变量命名 变量的名字必须由一个小写字母开头，后面的单词用大写字母开头。 如 userName 4 ）静态变量的命名 静态变量的名字应该都大写，并且指出完整含义。 如 public static final String LOG_CONFIG=”WEB-INF/Lperties ” 5）参数的命名 参数的名字必须和变量的命名规范一致。 6）数组的命名 数组应该总是用下面的方式来命名。 byte[] buffer;而不是 byte buffer]]; 7）方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名 字。 4?排版 换行 1） 较长的语句、表达式要等分成多行书写。 2） 长表达式要在低优先级操作符处划分新行，操作符放在新行之首。 3） 循环、判断等语句中若有较长的表达式或语句， 则要进行适当的划分。 4） 若函数中