网站开发编码规范

(参考Google Java部分编码规范)

 

类型

描述

例子

备注

包

1.包名必须全部小写，2个以内单词。

2.所有项目的包要以 “com.tianya” 为父 包

com.tianya.entity

虽然可能后面会采用org形式的域名也说不定。

类和接口

1.最好为名词，尽量短，不要缩写，除非是特别常用的类，

不能与标准库中的类名冲突。

2.命名类和接口时，所有单词首字母大写

3.接口命名采用末尾加上Interface，缺省接口要用Default座位名称前缀，再必须实现的方法加Impl做为名称后缀

4.抽象类命名采用首加上Abstract

5.异常类使用Exception做为名称后缀

6.运行一次就抛弃的类，以ing结尾

1.UserDao

2.AbstractSpringController

3.Rending

4.SqlInsertException

应尽量遵循，好习惯。

成员变量

1.最好为单数名词

2.如果是集合或者数组，用复数形式

3.不易理解的代码，尽量不要用一个字母，,用index或者cursor来代替.

Map pets 比 petMap要好

 

常量

单词需要要下划线分割

public final int MAX_VALUE = 30

 

局部变量

1.变量名尽量短，推荐用缩写

StringBuffer sb;

 

成员函数和静态函数

1.见名知意

2.setter / getter

1.findByPrimaryKey

//通过key来查找对象

 

2.不能如此写

private String name;

public void name()

{

return name;

}

public String name()

{

this.name = name;

}

//除非必要，不然不能这样写

 

注释

1.注释需要和代码保持同步。

注意: 一行注释不能呢个太长，太长的话，可以用

<br>标签，这样在其他开发人员看你的注释时会比较清晰

<pre>标签，用于包裹示例代码。也就是无需格式化。

2.类注释，shift+alt+j 采用模板，见例子

3.函数里的注释采用行注释，在需要注释的代码前加行注释

4.后期类需要别人来改的话，要在改的内容前加注释，见例子

1.类和方法注释模板

添加到MyEclipse中步骤为：

Window--->preferences-->java-->code style--->code templates--->comments

其中更改types , methods更改为下列模板即可

/**

*@author by:你的名字

* ${tags}

* @date ${date}

*/

 

 

编码

1.大括号另起一行，与结束行同列。这样比较美观，代码也比较清晰

2.公用继承的父类，必须经过大家协商才能进行更改，不可擅自往里面进行添加，删除等操作。

不用if(....){

}

 

而采用

if(...)

{

}

 

其他结构样式也需要这样。

 

代码的提交

1.必须能够编译运行后才能提交，如果与别人的代码产生冲突。必须改自己的代码以与别人的代码协同合作，而不能更改别人的代码。