优化代码规范

xtools-app-sys/xtools-app-sys-biz/src/main/java/xtools/app/sys/controller/SysBaseController.java

@@ -64,12 +64,24 @@ public class SysBaseController {
         return sysBaseService.getUserInfo();
     }
 
+    /**
+     * 修改用户信息
+     *
+     * @param req 修改用户信息参数
+     * @return 修改结果
+     */
     @Operation(summary = "修改用户信息")
     @PostMapping("/edit-user-info")
     public Result<Boolean> saveUserInfo(@RequestBody @Valid UserInfoEditReq req) {
         return sysBaseService.editUserInfo(req);
     }
 
+    /**
+     * 修改密码
+     *
+     * @param req 修改密码参数
+     * @return 修改结果
+     */
     @Operation(summary = "修改密码")
     @PostMapping("/edit-passwd")
     public Result<Boolean> editPasswd(HttpServletRequest request, @RequestBody @Valid UserInfoPasswdEditReq req) {
@@ -81,12 +93,24 @@ public class SysBaseController {
         return sysBaseService.editPasswd(req);
     }
 
+    /**
+     * 是否忽略脱敏
+     *
+     * @return 是否忽略脱敏
+     */
     @Operation(summary = "是否忽略脱敏")
     @GetMapping("/is-ignore-mask")
     public Result<Boolean> isIgnoreMask() {
         return Result.ok(AuthUtils.isIgnoreMask());
     }
 
+    /**
+     * 忽略脱敏
+     *
+     * @param request 请求
+     * @param req     忽略脱敏参数
+     * @return 忽略结果
+     */
     @Operation(summary = "忽略脱敏")
     @PostMapping("/ignore-mask")
     public Result<Boolean> ignoreMask(HttpServletRequest request, @RequestBody @Valid IgnoreMaskReq req) {
@@ -98,12 +122,22 @@ public class SysBaseController {
         return sysBaseService.ignoreMask(req);
     }
 
+    /**
+     * 取消忽略脱敏
+     *
+     * @return 取消结果
+     */
     @Operation(summary = "取消忽略脱敏")
     @GetMapping("/unignore-mask")
     public Result<Boolean> unIgnoreMask() {
         return sysBaseService.unIgnoreMask();
     }
 
+    /**
+     * 退出登录
+     *
+     * @return 退出结果
+     */
     @Operation(summary = "退出登录")
     @GetMapping("/logout")
     public Result<Boolean> logout() {
@@ -112,12 +146,23 @@ public class SysBaseController {
         return Result.ok(true);
     }
 
+    /**
+     * 获取更新历史
+     *
+     * @return 更新历史
+     */
     @Operation(summary = "获取更新历史")
     @GetMapping("/get-update-history")
     public Result<List<SysUpdateHistoryResp>> getUpdateHistory() {
         return sysUpdateHistoryService.getAll(0);
     }
 
+    /**
+     * 查询ip对应的地址
+     *
+     * @param ip ip
+     * @return 地址
+     */
     @Operation(summary = "查询ip对应的地址")
     @GetMapping("/get-ip-address/{ip}")
     public Result<SysIpAddrResp> getIpAddress(

xtools-app-sys/xtools-app-sys-biz/src/main/java/xtools/app/sys/controller/SysDictController.java

@@ -54,6 +54,12 @@ public class SysDictController {
 
     private final SysDictService sysDictService;
 
+    /**
+     * 分页请求
+     *
+     * @param pageReq 请求参数
+     * @return 分页结果
+     */
     @Operation(summary = "分页请求")
     @PostMapping("page")
     public Result<PageResp<SysDictResp>> page(@RequestBody @Valid PageReq<SysDictPageReq> pageReq) {

xtools-app-sys/xtools-app-sys-biz/src/main/java/xtools/app/sys/controller/SysUserController.java

@@ -44,12 +44,24 @@ public class SysUserController {
 
     private final SysUserService sysUserService;
 
+    /**
+     * 分页请求
+     *
+     * @param pageReq 分页请求参数
+     * @return 分页响应
+     */
     @Operation(summary = "分页请求")
     @PostMapping("page")
     public Result<PageResp<SysUserResp>> page(@RequestBody @Valid PageReq<SysUserPageReq> pageReq) {
         return sysUserService.page(pageReq);
     }
 
+    /**
+     * 获取数据
+     *
+     * @param id ID
+     * @return 数据
+     */
     @Operation(summary = "获取数据")
     @GetMapping("base/{id}")
     public Result<SysUserResp> getById(
@@ -61,24 +73,48 @@ public class SysUserController {
         return sysUserService.getById(id);
     }
 
+    /**
+     * 添加数据
+     *
+     * @param req 添加数据参数
+     * @return 添加结果
+     */
     @Operation(summary = "添加数据")
     @PostMapping("base")
     public Result<Boolean> add(@RequestBody @Valid SysUserAddReq req) {
         return sysUserService.add(req);
     }
 
+    /**
+     * 更新数据
+     *
+     * @param req 更新数据参数
+     * @return 更新结果
+     */
     @Operation(summary = "更新数据")
     @PutMapping("base")
     public Result<Boolean> update(@RequestBody @Valid SysUserUpdateReq req) {
         return sysUserService.update(req);
     }
 
+    /**
+     * 删除数据
+     *
+     * @param req 删除数据参数
+     * @return 删除结果
+     */
     @Operation(summary = "删除数据")
     @DeleteMapping("base")
     public Result<Boolean> delById(@RequestBody @Valid IdListReq req) {
         return sysUserService.delById(req.getIdList());
     }
 
+    /**
+     * 根据 ID 集合查询
+     *
+     * @param req 查询参数
+     * @return 查询结果
+     */
     @Operation(summary = "根据 ID 集合查询")
     @PostMapping("get-list-by-ids")
     public Result<List<SysUserResp>> getListByIds(@RequestBody @Valid IdListReq req) {