《JAVA编程规范初稿.docxVIP

JAVA编程规范初稿 ――作者：庄哲锋命名规范：? Package 的命名 Package 的名字应该都是由一些小写单词组成。 一般使用公司的域名反写开头，如com.tongrong,各项目以其项目名称作为三层包名，之后就是各个子模块的名称；公司构件库的命名以com.tongrong.code开头，之后针对不通的用途区分子包，如com. tongrong.code.xml等。? Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成，每个单词的首字母都必须大写。类名应尽量体现它的功能和类别,工具类的命名一般以Util或者Helper结尾。 如： AddUserAction 类别：控制类? Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。一般是类型的首字母小写。一个类（方法）中有多个引用时后面可加序号，但必须加上注释。如 addUserBPO //添加用户的业务处理对象? Static Final 变量的命名 Static Final 变量的名字应该都大写(或者数字和_)，并且指出完整含义。词间用下划线分开。如static final LOGIN_PAGE=”login.jsp” //登陆页面。注意：一般静态最终变量是不建议在接口里面定义（sun规范），而应该在final class中定义。?变量与参数的命名 参数和变量的命名必须体现出参数或者变量的用途，命名方法和类的方法一致。参数必须用javadoc或者是/* */注释，变量一行只能声明一个，而且必须在后面用 //注释清楚(private,package)或者用/** */注释(protected,public)，如：SysUserDAO sysUserDAO? 数组的命名 数组应该总是用下面的方式来命名： 注意：一般后面加个s表复数。String[] names; ? 而不是：String names[]; ? 方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字，注意要写注释，对于设置函数记得前面的this，方法参数一般不能多于4个，否则用bean统一封装：setSize(int size){ this.size = size; }Java 文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则版权信息 版权信息必须在 每个java 文件的开头（一般不用javadoc方式，直接用多行注释，可以在开发工具中设置，比如eclipse可以在窗口首选项java代码模板 中设置），比如：? Package/Imports package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列，注意import的每个类都要具体指出包名，而不能用.*代替（使用类的导入可以借用工具的组织导入功能进行，比如eclipse中用快捷键ctrl+shift+O）。package com.startdragon.code.xml import java.util.Observable; import com.startdragon.code.util;? 类的注释 一般要描述类的功能，第一行简要描述类的功能，记得后面加”.”,接下来具体描述类的功能。一般在类的javadoc中要加上@author和@version标记，一般在稳定版发布前的version都设置为1.0,发布后可根据具体的情况修改。可以通过工具的模板辅助产生，eclipse中的设置方法如“版权信息”的设置。/** * 添加用户业务处理对象. * Usage: AddUserBSImpl通过该类把一下相对来说比较负责的业务转移到该类处理，通过 *调用响应的方法实现对应的业务操作 * @author a href=mailto:longlong2008@weiconghui/a * @version 1.0 */public class AddUserBPO { ? 类定义 包含了在不同的行的 extends 和 implements，注意缩进问题，一般类的行数不要超过1000，方法个数不要超过10。public class CounterSet extends Observable implements Cloneable? 类的成员变量 Public，proceted 的成员变量必须生成文档（JavaDoc）。private和 package 定义的成员变量除了名字含义要明确，还必须在后面用 “//” 注释： ? 存取方法 类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上，注意如果引用类变量，一般前面要加上this。/** *