feat(REQ-2106): 注释规范化

banner/banner-api/src/main/java/cn/axzo/nanopart/api/ApplicationVersionApi.java

@@ -17,6 +17,8 @@ import org.springframework.web.bind.annotation.RequestParam;
 import javax.validation.Valid;
 
 /**
+ * 版本记录相关api
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/2 10:21

banner/banner-api/src/main/java/cn/axzo/nanopart/api/BannerApi.java

@@ -16,6 +16,8 @@ import org.springframework.web.bind.annotation.RequestBody;
 import javax.validation.Valid;
 
 /**
+ * 广告位相关 api
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/2 10:19
@@ -27,7 +29,7 @@ public interface BannerApi {
      * 分页查询banner
      *
      * @param req {@link PageBannerReq}
-     * @return  按照站点code(code)自增排序后列表 {@link PageBannerResp}
+     * @return 按照站点code(code)自增排序后列表 {@link PageBannerResp}
      */
     @PostMapping("/api/banner/page")
     ApiPageResult<PageBannerResp> page(@RequestBody @Valid PageBannerReq req);
@@ -67,6 +69,4 @@ public interface BannerApi {
      */
     @PostMapping("/api/banner/detail")
     ApiResult<DetailBannerResp> detail(@RequestBody @Valid DetailBannerReq req);
-
-
 }

banner/banner-api/src/main/java/cn/axzo/nanopart/api/BannerOperationLogApi.java

@@ -10,6 +10,8 @@ import org.springframework.web.bind.annotation.RequestBody;
 import javax.validation.Valid;
 
 /**
+ * 广告位和素材操作日志
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/2 10:21

banner/banner-api/src/main/java/cn/axzo/nanopart/api/MaterialApi.java

@@ -18,6 +18,8 @@ import javax.validation.Valid;
 import java.util.List;
 
 /**
+ * 素材管理相关 api
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/2 10:20
@@ -84,5 +86,4 @@ public interface MaterialApi {
      */
     @PostMapping("/api/material/listByBannerCode")
     ApiResult<List<MaterialResp>> listMaterialByBannerCode(@RequestBody @Valid ListMaterialByBannerCodeReq req);
-
 }

banner/banner-server/src/main/java/cn/axzo/nanopart/server/controller/ApplicationVersionController.java

@@ -19,6 +19,8 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.Objects;
 
 /**
+ * 版本记录操作
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/3 16:39
@@ -55,7 +57,7 @@ public class ApplicationVersionController implements ApplicationVersionApi {
 
     @Override
     public ApiResult<GetVersionUpdateRemindContentResp> getVersionUpdateRemindContent(GetVersionUpdateRemindContentReq req) {
-        if (Objects.isNull(req.getPersonId()) || req.getPersonId() == 0){
+        if (Objects.isNull(req.getPersonId()) || req.getPersonId() == 0) {
             throw new ServiceException("personId不能为空");
         }
         return ApiResult.ok(applicationVersionService.getVersionUpdateRemindContent(req));

banner/banner-server/src/main/java/cn/axzo/nanopart/server/controller/BannerController.java

@@ -17,6 +17,8 @@ import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
+ * 广告位操作
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/3 16:30
@@ -30,7 +32,7 @@ public class BannerController implements BannerApi {
 
     @Override
     public ApiPageResult<PageBannerResp> page(PageBannerReq req) {
-        Page<PageBannerResp> pageData =  bannerService.page(req);
+        Page<PageBannerResp> pageData = bannerService.page(req);
         return ApiPageResult.ok(pageData);
     }
 

banner/banner-server/src/main/java/cn/axzo/nanopart/server/controller/BannerOperationLogController.java

@@ -11,6 +11,8 @@ import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
+ * 广告位和素材操作日志
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/3 16:40

banner/banner-server/src/main/java/cn/axzo/nanopart/server/controller/MaterialController.java

@@ -24,6 +24,8 @@ import java.util.List;
 import java.util.Objects;
 
 /**
+ * 素材操作
+ *
  * @author chenwenjian
  * @version 1.0
  * @date 2024/4/3 16:31
@@ -68,9 +70,9 @@ public class MaterialController implements MaterialApi {
     @Override
     public ApiResult<List<MaterialResp>> listMaterialByBannerCode(ListMaterialByBannerCodeReq req) {
         String traceId = request.getHeader(NanopartConstant.CONTEXT_TRACE_ID);
-        if (Objects.isNull(req.getPersonId()) || req.getPersonId() == 0L){
+        if (Objects.isNull(req.getPersonId()) || req.getPersonId() == 0L) {
             throw new ServiceException("personId不能为空");
         }
-        return ApiResult.ok(materialService.listMaterialByBannerCode(req,traceId));
+        return ApiResult.ok(materialService.listMaterialByBannerCode(req, traceId));
     }
 }