一、命名规则
1.项目名
全部小写,多单词可用“-”间隔,例如:
blog-api
2.包名
全部小写,为了避免类库重复,应该使用开发域名的反写形式,例如:
com.moonce.blog
3.类名
首字母大写,如果为多个单词,则每个单词的首字母大写(驼峰命名法),例如:
public class MyClass{}
4.方法名、变量名
变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。(驼峰命名法)例如:
public void isMethod(){}//方法
int isNum = 0; //变量
5.常量名
常量名全部大写,如多个单词则用“_”隔开,例如:
public static final String SYSTEM_ERROR_MSG="系统错误!";
6.所有命名规则必须遵循的规则
- 名称只能由字母、数字、下划线、$符号组成。
- 不能以数字开头。
- 名称不能使用JAVA中的关键字。
- 坚决不允许出现中文及拼音命名。
二、注释规则
1.类注释
类注释为每个类前面添加的注释,主要为该类的详细说明,以及该类的一些相关信息。例如:
/**
* 类的详细说明
* @author 类创建者姓名
* @Date 创建日期
* @version 1.00
*/
2.方法注释
类方法注释为每个类方法前面添加的注释,主要为该类方法的详细说明,参数、返回结果和异常处理等。例如:
/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @param 参数2 参数2的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
3.构造方法注释
构造方法注释为每个构造方法前面添加的注释,主要为该类方法的详细说明,参数和异常处理等。例如:
/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @param 参数2 参数2的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
4.方法内部注释
方法内部注释可使用多行和单行注释,一般内容较少使用单行注释,内容多的时候使用多行注释。例如:
String str = getStringMethod() //获取getStringMethod()方法结果
/*
获取getIntMethod()方法结果,
如果num等于1,则输出成功
如果num等于0,则输出失败
*/
int num = getIntMethod()
if(num==1){
System.out.println("成功");
}else if(num==0){
System.out.println("失败");
}
5.字段、属性、常量注释
/** 编号 */
private Long id;
/** 操作客户信息层 */
private CustomerService customerService
/** 系统错误提示 */
public static final String SYSTEM_ERROR_MSG="系统错误!";