软件开发代码规范Java.docVIP

.

PAGE/NUMPAGES

.

软件开发代码规（C）

(仅通普信息技术股份供部使用)

拟制：

超

日期：

2015-3-10

夏峰

日期：

2015-3-10

核准：

敬刚

日期：

2015-3-17

签发：

殿成

日期：

2015-3-21

文档版本：V1.11

通普信息技术股份

版本历史

日期

版本

说明

作者

目录

TOC\o1-3\h\z第一章代码开发规与其指南1

1.1目的1

1.2程序命名规1

1.3文件命名规2

1.4Java文件样式2

1.5代码编写格式6

第二章程序编写规方法8

2.1权限修饰8

2.2其他规8

2.3编程指南10

第三章其他要求12

代码开发规与其指南

目的

定义这个规的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规并不是一定要绝对遵守，但是一定要让程序有良好的可读性）

程序命名规

Package的命名：Package的名字应该都是由一个小写单词组成。

Class的命名：Class的名字必须由大写字母开头而其他字母都小写的单词组成

Class变量的命名：变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。

StaticFinal变量的命名：StaticFinal变量的名字应该都大写，并且指出完整含义。

参数的命名：参数的名字必须和变量的命名规一致。

数组的命名：数组应该总是用下面的方式来命名：byte[]buffer;而不是bytebuffer[];

方法的参数：使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：

SetCounter(intsize){

this.size=size;

}

文件命名规

文件名由英文单词组成，每个单词的首字母大写，不要超过4个单词，如ShipOrder.jsp。

Java文件的文件名要与程序中的public类名一样。

Servet文件要以Servlet做为结尾，如AddCompanyServlet.java

业务处理组件JavaBean要以Bean为结尾，如ProcessBean.java

Java文件样式

所有的Java(*.java)文件都必须遵守如下的样式规则

头部

信息

信息必须在java文件的开头，比如：

/**

*Copyright2002SunMicrosystems,Inc.Allrightsreserved.

*/

其他不需要出现在javadoc的信息也可以包含在这里。

Package/Imports

package行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。

packagehotlava.net.stats;

importjava.io.*;

importjava.util.Observable;

importhotlava.util.Application;

这里java.io.*使用来代替InputStreamandOutputStream的。

Class

接下来的是类的注释，一般是用来解释类的相关信息，包括标题、描述、。

/**

*pTitle:Example/p

*pDescription:AuditApplicationExample/p

*pCopyright:Copyright(c)200x/p

*pCompany:xxxxx/p

*authorxxxxxx

*version1.0

*/

接下来是类定义，包含了在不同的行的extends和implements

publicclassCounterSetextendsObservableimplementsCloneable

ClassFields

接下来是类的成员变量：

/**

*Packetcounters

*/

protectedint[]packets;

public的成员变量必须生成文档（JavaDoc）。protected、private和package定义的成员变量如果名字含义明确的话，可以没有注释。

存取方法

接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。

/**

*Getthecounters

*returnanarraycontainingthestatisticaldata.Thisar