《程序开发规范》.docVIP

程序开发规范 目的 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。 命名规范 Package 的命名 Package 的名字应该都是由一个小写单词组成， 如：package com.wholewise.ucss.workflow；。 在UCSS项目中，我们对所有的包做如下规定： package com.wholewise.ucss.*; 其中，*是开发人员根据模块自己定义的。 Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成，最好用有意义的单词命名。 如：class GetTreeInfo,class TransToXml等。 Class 变量的命名 类对象的名字必须用一个小写字母开头。后面的单词用大写字母开头。 数据类型的变量第一个字母为变量类型的缩写。如：sPassword,iCount。 关于数据类型标识的说明(弱化该要求，尽量保持) 数据类型 数据类型标识 数据类型 数据类型标识 整型(int) i 浮点型(float) f 字符串型(String) s 字符型(char) c 浮点型(double) d 布尔型(boolean) b 长整型(long) l 数组(Array) a StringBuffer sb 二维数组 aa Static Final 变量的命名 Static Final 变量的名字应该都大写，并且指出完整含义。 如：private static final int SERVER_PORT=7100； //表示服务器端口号。 参数的命名 参数的名字必须和变量的命名规范一致。 数组的命名 数组应该总是用下面的方式来命名： byte[] aBuffer; 而不是： byte aBuffer[]; 方法的命名 使用有意义的参数命名，原则上是动词+名词。且除第一个单词外其他单词的第一个字母大写。如果可能的话，使用和要赋值的字段一样的名字： public void setSize(int iSize){ this.iSize = iSize; } public int getSize() { return this.iSize; } Java 文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则。 版权信息 版权信息必须在 java 文件的开头，比如： /** * Copyright ? 2001 WholeWise Sci.Tech.Co.,Ltd * All right reserved. * MODIFIED (YYYY-MM-DD) * V1.0.0.0 developer 2000-01-01 created * V1.0.0.1 changer 2000-02-01 modified */ 其他不需要出现在 javadoc 的信息也可以包含在这里。 Package/Import package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。 package com.wholewise.ywzx; import java.io.*; import java.util.Observable; import com.wholewise.ucss.tool.UseJolt; 这里 java.io.* 使用来代替InputStream and OutputStream 的。 如果你能确定你要调用包中的哪一个类，指明具体的类会更好。 如： import java.io. InputStream; import java.io. OutputStream; import java.util.Observable; import com.wholewise.ucss.tool.UseJolt; 这样运行速度会更快些，查错也方便。 Class 接下来的是类的注释，一般是用来解释类的。 /** * 描述这个类的功能 */ 接下来是类定义， public class CounterSet extends Observable implements Cloneable； Class Fields 接下来是类的成员变量： protected int iSize; public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。 构造函数 接下来是构造函