java编程规范摘要

 

在提交svn前，要先进行获取，避免强制覆盖，必须与相关人员进行沟通。

 

包名应该用小写字母，不要出现下划线等符号，名词用有意义的缩写或 者英文单词。

示例：

 

//推荐 com.newheight.dao java.lang.util

_//避免

 

com.Esse-tech.buSiness

 

 

 

2)    所有类命名使用 Pascal 表示方式，使用名词组合。

 

UserManager, ClassLoader, HttpHeaderResult

 

 

 

3)    接口命名使用字母“I”加上 Pascal 形式的表示方式。

 

IQuery, IDataAccess,IReportBuilder

4) 使用名词组合或形容词去命名一个接口，接口声明了一个对象能提供的 服务，也描述了一个对象的能力。一般以“able”和“ible”作为后缀， 代表了一种能力。

 

 

 

public interface Runnable{

 

public void run();

 

^}

 

 

 

public interface Accessible{

 

public Context getContext();

 

^}

 

 

 

5)    变量名和参数名使用 Camel 表示方式。

 

userName, objectFactory, entrys, list

6) 对于常量名，使用大写字母，并使用下划线做间隔。 MAX_TIMES, DEFAULT_NAME 程序中应该使用常量代替“25”，“100”等实际的数字，如：

 

 

 

//推荐

if(times == MAX_TIMES){

 

…

 

^}

 

 

 

//避免

 

if(times == 25){

 

…

 

^}

 

 

 

这样做的好处是，当因需要修改实际的数字时，比如修改 25 为 30，只需要 修改一处。

 

 

 

7) 方法名应该使用动词开头，使用  Camel 表示方式,一般由动词+名词组 成。

getName, initialize, addParameter, deleteUser

 

 

 

8)    缩写字母也应该保持首字母大写

exportHtmlSource(); // 避免: exportHTMLSource();

 

openDvdPlayer();     // 避免: openDVDPlayer();

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

9)    变量的名字应该和类型名称一致

void setTopic(Topic topic) // 避免: void setTopic(Topic value)

 

// 避免: void setTopic(Topic aTopic)

 

// 避免: void setTopic(Topic t)

 

void connect(Database database)

 

// 避免: void connect(Database db)

 

// 避免: void connect(Database oracleDB)