Browse Source

更新 '开发文档.md'

root 4 years ago
parent
commit
ab4370915c
1 changed files with 6 additions and 3 deletions
  1. 6 3
      开发文档.md

+ 6 - 3
开发文档.md

@@ -140,7 +140,7 @@ public Response<TMClassRecordDetail> getInfo(
 
 ```
 3. 异常
-Controller层,可直接使用Response.error ,重载了多个方法,根据具体情形使用
+* Controller层,可直接使用Response.error ,重载了多个方法,根据具体情形使用
 
 ```java
 @Log(title = "电子教学日志", businessType = BusinessTypeEnum.INSERT)
@@ -155,7 +155,7 @@ public Response<Integer> add(@RequestBody TMClassRecordDetail tMClassRecordDetai
 
 
 ```
-service层,若有运行时异常,无需捕获,直接抛出自定义异常,如业务异常:CustomException,统一由全局 异常处理器GlobalExceptionHandler 进行处理,例子如下:
+* service层,若有运行时异常,无需捕获,直接抛出自定义异常,如业务异常:CustomException,统一由全局 异常处理器GlobalExceptionHandler 进行处理,例子如下:
 
 ```java
 private void validateCode(String principal, String credential) {
@@ -172,6 +172,7 @@ private void validateCode(String principal, String credential) {
 
 ```
 4. 枚举类
+
 原则上,代码中不应该出现魔法数字,比如下面代码
 ```java
 if (type == 1){
@@ -212,7 +213,9 @@ if (type == UserStatusEnum.OK.getCode()){
 }
 ```
 
-5. 入参,出参 ,如果传入参数与实体字段相差较大,可以新建DTO对象,DTO 意思为数据传输对象,包含了出参,入参,如果为了区分,也可以把入参命名为DTO,返参命名为VO
+5. 入参,出参 
+
+如果传入参数与实体字段相差较大,可以新建DTO对象,DTO 意思为数据传输对象,包含了出参,入参,如果为了区分,也可以把入参命名为DTO,返参命名为VO
 ```java
 @PostMapping("/login")
 @ApiOperation("系统-登录方法")