命名规范与规则

命名规范

1、项目名全部小写，就是如果项目名是多个英语单词组成的，每个单词都要全部小写。

如：doubanssm。

2、包名全部小写。

3、类名首字母大写，若类名由多个单词构成，每个单词首字母大写，即大驼峰命名

public class HelloWorld(){ }

4、变量名、方法名首字母小写，若其由多个单词构成，除变量名首字母外的其它每个单词首字母大写，即小驼峰命名法

public void sayHello(){ }

String userName ="luis";

5、常量名全部大写

如：public static final int ANIMAL_NUMBER=15;

6、实体类属性全部小写

命名规则

1、名称只能由字母、数字、下划线、$符号组成

2、不能以数字开头

3、名称不能使用JAVA中的关键字。

4、坚决不允许出现中文及拼音命名。

系统命名

要求：

1、统一用英文

2、名称不宜过长

3、全部小写

注释

类注释(Class)

类注释(Class)主要用来声明该类用来做什么，以及创建者、创建日期版本、包名等一些信息:

/**
 * @version: V1.0
 * @author: fendo
 * @className: user
 * @packageName: user
 * @description: 这是用户类
 * @data: 2017-07-28 12:20
 **/

方法注释(Methods)

方法注释(Methods)主要用来声明该类的作用、入参、返回值、异常等信息:

/**
* @author:  fendo
* @methodsName: addUser
* @description: 添加一个用户
* @param:  type 交易类型
* @param:  data 交易数据
* @return: String 
* @throws: 
*/

其他

 

等号两边要各留一个空格。