Java程序开发规范提纲

1.   编码规范

3.1 Package的命名

Package的名字都由一个小写单词组成。单词只能由小写字母组成。

每个Package必须由：com.jutone.[project name].[module name]组成。

例如Jserver项目中：com.jutone.jserver.cpmanagement

Lottery项目中：com.jutone.lottery.sms

3.2 class和interface的命名

可以由一个或多个单词组成，每个单词的第一个字母必须大写，单词与单词之间不使用下划线连结。class和interface的单词组合后最终的意思为名词。

3.3 static final变量的命名

由一个或多个单词组成，变量的名字都大写，单词与单词之间使用下划线连结。变量的描述要完整，不允许缩写单词出现。变量的最终意思为名词。变量例如：

HIERARCHY_REQUEST_ERROR

3.4 class和interface成员变量的命名

由一个或多个单词组成，第一个单词全部小写，以后的单词的首写字母大写，单词与单词之间不使用下划线连结。变量中的单词允许缩写，缩写单词的字母都大写，不允许连续出现缩写的单词，首单词不允许缩写，缩写的单词必须在文件的开头注释中申明。变量的最终意思为名词。变量例如：

DOMString documentURL; //正确

long CPID; //错误，连续的缩写，并且首单词使用了缩写。

long contentProviderID;//正确

boolean isId;//错误，ID是缩写，因此应该用ID而不是Id，在www.w3.org中有这样的定义，但是在本公司内不采用这样的方法。

boolean isID;//正确

 

3.5 class和interface成员method的命名

由一个或多个单词组成，第一个单词全部小写，以后的单词的首写字母大写，单词与单词之间不使用下划线连结。命名中的单词允许缩写，缩写单词的字母都大写，不允许连续出现缩写的单词，首单词不允许缩写，缩写的单词必须在文件的开头注释中申明。命名的最终意思为动词。命名例如：

public void getContentsProviderID();//正确

public void getCPID();//错误，有连续的缩写。

public void getCPIdentity();//正确。

public void getContentsProviderId();//错误，ID为缩写，因此要全部大写，在www.w3.org中，这种方式被认可，但是在本公司不被认可。

3.6 在单元测试中的类命名规则

在单元测试中（动态白盒），测试类的命名方式是使用小写的test+原有的类名称。例如要测试Car类使用的测试类是testCar。

3.7在method中局部变量的命名

命名方式见3.4，为了保持一致，不特意采用匈牙利命名规范。

3.8数组的命名

byte[] buffer;

不是

byte buffer[];

2.   书写规范

4.1 javadoc的使用

// 表示注释一行，该注释不会被javadoc翻译到文档中，开发人员可以随意使用。

/*……..*/，注释若干行，该注释不会被javadoc翻译到文档中，开发人员可以随意使用。

/**…….*/，生成文档的注释，支持HTML文法。

4.1.1 class的javadoc

需要书写该类的说明，如类的描述，功能，类型，与其他类的交互等等。

/**

 * description

 */

4.1.2 attribute的javadoc

由于大部分的attribute为私有变量，所以不需要写在JAVADOC中，所以只需要用“//”来书写注释。

// description

4.1.3 method的javadoc

需要描述的有该方法的功能说明，接受的参数，返回值等等。

/**

     * The method is used for adding object.

     * @param EndUserInfo endUserInfo

     * @return int

     * success - 0

     * failed - -1

     */

4.2 文件头

/**

 * File: file name

 * Description:file description

 * @author author name

 * @version version NO.

 * Cop