一、命名规范
- (除了配置文件之外)所有的命名中均只能包含字母、数字、下划线"_"
- 包名的命名规范:
- 全部为小写字母
- 一般为公司域名反写开头,例如: com.baidu.tieba
- 类名或者接口名,均要求大写字母开头,如果是多个单词,则采用驼峰命名法,例如:UserService
- 方法名一般为动词或者动词词组,均要求小写字母开头,如果是多个单词则采用驼峰命名法,例如: findById()
- 变量名均要求以小写字母开头,如果是多个单词,则采用驼峰命名法,例如: userInfo;变量名要求尽量精简,而且要具备可读性
- 常量全部为大写字母,每个单词之间用"_"连接,例如USERNAME_SESSION_KEY
二、注释规范
- 每一个类的开头,应该具备一个注释,用于描述作者、日期时间、以及类的功能
- 每一个方法都必须添加文档注释,用于描述方法的具体功能、参数、返回值等等信息
- 类的成员变量,使用"//"注释描述成员变量
- 稍微复杂的流程,使用"//"注释描述代码的流程步骤