1、项目名
全部小写。如:workdesk、jobserver。
2、包名
全部小写,名词。如:java.awt.event。
3、类名、接口名
首字母大写,多个单词组成时,每个单词的首字母大写。如:
public class MyClass {}
4、方法名
首字母小写,多个单词组成时,从第二个单词开始,每个单词的首字母大写。第一个单词一般为动词,如:
public void toString() {}
5、变量名
5.1 普通变量名
同方法的命名,一般为名词。如:
int index=0;
5.2 常量名(静态变量名)
全部大写。如:
public static final String GAME_COLOR=”RED”;
6、属性文件properties
以下划线隔开。如:errors_zh_CN.properties,hibernate_test.properties
7、数据库命名:
表、字段命名全部大写,多个单词以_隔开
8、注释规范
8.1、类注释
在每个类前面必须加上类注释,注释模板如下:
/**
-
Copyright ©, 2006-2010, Anhui Love info. Co., Ltd.
-
FileName: Test.java
-
类的详细说明
-
@author 类创建者姓名
-
@Date 创建日期
-
@version 1.00
*/
8.2、属性注释
在每个属性前面必须加上属性注释,注释模板如下:
/** 提示信息 */
private String strMsg = null;
8.3、方法注释
在每个方法前面必须加上方法注释,注释模板如下:
/**
-
类方法的详细使用说明
-
@param 参数1 参数1的使用说明
-
@return 返回结果的说明
-
@throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
8.4、构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:
/**
-
构造方法的详细使用说明
-
@param 参数1 参数1的使用说明
-
@throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
8.5、方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。如:
//背景颜色
Color bgColor = Color.RED