优化代码规范

xtools-app-gen/xtools-app-gen-biz/src/main/java/xtools/app/gen/controller/GenTableController.java

@@ -58,12 +58,24 @@ public class GenTableController {
 
     private final GenTableService genTableService;
 
+    /**
+     * 分页请求
+     *
+     * @param pageReq 分页参数
+     * @return 分页结果
+     */
     @Operation(summary = "分页请求")
     @PostMapping("page")
     public Result<PageResp<GenTableResp>> page(@RequestBody @Valid PageReq<GenTablePageReq> pageReq) {
         return genTableService.page(pageReq);
     }
 
+    /**
+     * 获取数据
+     *
+     * @param id ID
+     * @return 数据
+     */
     @Operation(summary = "获取数据")
     @GetMapping("base/{id}")
     public Result<GenTableResp> getById(
@@ -75,24 +87,48 @@ public class GenTableController {
         return genTableService.getById(id);
     }
 
+    /**
+     * 添加数据
+     *
+     * @param req 参数
+     * @return 结果
+     */
     @Operation(summary = "添加数据")
     @PostMapping("base")
     public Result<Boolean> add(@RequestBody @Valid GenTableAddReq req) {
         return genTableService.add(req);
     }
 
+    /**
+     * 更新数据
+     *
+     * @param req 参数
+     * @return 结果
+     */
     @Operation(summary = "更新数据")
     @PutMapping("base")
     public Result<Boolean> update(@RequestBody @Valid GenTableUpdateReq req) {
         return genTableService.update(req);
     }
 
+    /**
+     * 删除数据
+     *
+     * @param req 参数
+     * @return 结果
+     */
     @Operation(summary = "删除数据")
     @DeleteMapping("base")
     public Result<Boolean> delById(@RequestBody @Valid IdListReq req) {
         return genTableService.delById(req.getIdList());
     }
 
+    /**
+     * 根据数据源 ID 删除表信息
+     *
+     * @param id 数据源 ID
+     * @return 结果
+     */
     @Operation(summary = "根据数据源 ID 删除表信息")
     @DeleteMapping("del-by-datasource-id/{id}")
     public Result<Boolean> delByDatasourceId(
@@ -104,6 +140,12 @@ public class GenTableController {
         return genService.delTableAndColumnByDatasourceId(id);
     }
 
+    /**
+     * 同步数据库
+     *
+     * @param id 数据源 ID
+     * @return 结果
+     */
     @Operation(summary = "同步数据库")
     @GetMapping("sync-db/{id}")
     public Result<Boolean> syncDb(
@@ -115,6 +157,12 @@ public class GenTableController {
         return genService.syncDb(id);
     }
 
+    /**
+     * 同步字段
+     *
+     * @param id 表 ID
+     * @return 结果
+     */
     @Operation(summary = "同步字段")
     @GetMapping("sync-column/{id}")
     public Result<Boolean> syncColumn(
@@ -126,24 +174,47 @@ public class GenTableController {
         return genService.syncColumn(id);
     }
 
+    /**
+     * 获取表格信息
+     *
+     * @param req 表 ID 列表
+     * @return 结果
+     */
     @Operation(summary = "获取表格信息")
     @PostMapping("get-table-list")
     public Result<List<GenTableInfoResp>> getTableList(@RequestBody @Valid IdListReq req) {
         return genService.getTableList(req.getIdList());
     }
 
+    /**
+     * 保存表格信息
+     *
+     * @param req 参数
+     * @return 结果
+     */
     @Operation(summary = "保存表格信息")
     @PostMapping("save-table-list")
     public Result<Boolean> saveTableList(@RequestBody @Valid List<GenTableInfoReq> req) {
         return genService.saveTableList(req);
     }
 
+    /**
+     * 预览代码
+     *
+     * @param req 表 ID 列表
+     * @return 结果
+     */
     @Operation(summary = "预览代码")
     @PostMapping("preview-code")
     public Result<List<GenCodeDto>> previewCode(@RequestBody @Valid IdListReq req) {
         return genService.previewCode(req.getIdList());
     }
 
+    /**
+     * 下载代码
+     *
+     * @param req 表 ID 列表
+     */
     @Operation(summary = "下载代码")
     @PostMapping("download-code")
     public void downloadCode(HttpServletResponse response, @RequestBody @Valid IdListReq req) {