Commit 1c26f741 authored by yang's avatar yang

Update codeStyle.md

parent 1b1db8ab
......@@ -15,13 +15,28 @@ if(user.getStatus() == 5){
```
6. 在类中定义的常量、变量及方法,需要严格控制访问修饰符,提供自己使用的设为private,可以供别人使用的可以设为public、protected等。
7. 所有的覆写方法,必须加@Override注解,防止错误的拼写导致意外。
7. 所有的覆写方法,必须加**@Override**注解,防止错误的拼写导致意外。
8. Long类型的数据在初始化时必须使用大写的字母L,Double类型的数据必须使用大写的字母D。常见形式如
- **Long time=10000L**
- **Double money=12.3D**
9. 所有的数值的包装类型之间的比较不允许使用<>、==之类的简单运算符,需要使用equals方法或者compareTo方法。
10. 所有方法的引用类型参数,若是未添加**@NotNull**注解,必须先进行null判断。
11. 捕获异常一般不允许直接捕获基类Exception,也不可捕获异常后不进行处理。方法中也不可抛出基类Exception。
12. 部分异常若是上层(调用层)不能解决,则不允许抛出。最外层若是出现异常必须自行处理,不可将异常信息直接展示给用户。
13. 所有的日志信息**不允许使用System.out.println**输出,异常的日志信息使用**log.error**打印时,必须使用重载方法将捕获的异常作为第二个参数。如:
```java
try{
// throw some exceptions
}catch(IOException e){
logger.error(e.getMessage(), e);
}
```
--- ---
## 二、命名规范
1. 所有的命名不允许使用**拼音或者拼音英文混合**方式,但部分公认的拼音允许使用,如**shanghai,beijing**等。
2. 所有的命名不允许使用**下划线_**或者**美元符$**作为起始或者结束。错误的情况有不限于以下几种:
2. 所有的命名不允许使用**下划线`_`**或者**美元符`$`**作为起始或者结束。错误的情况有不限于以下几种:
- **_param**
- **$param**
- **param_**
......@@ -38,7 +53,7 @@ if(user.getStatus() == 5){
- 存放该模块数据库实体对象: **dto**
- 存放该模块的部分组件: **components**
- 存放该模块的业务接口: **service**
- 存放模块的业务实现类: **service.impl**
- 存放模块的业务实现类: **service.impl**
- 存放该模块的Mybatis数据库交互层代码: **mapper**
- 存放该模块的工具类代码: **utils**
- 存放自定义的异常类代码: **exception**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment