码表注释

src/main/java/com/chelvc/cloud/admin/controller/DictEntryController.java

@@ -16,6 +16,7 @@ import javax.validation.constraints.Min;
 import java.util.List;
 
 /**
+ * 码表条目控制层
  * @author valley
  * @date 2024/01/11 22:20
  **/
@@ -29,26 +30,46 @@ public class DictEntryController {
     @DubboReference
     private DictEntryService dictEntryService;
 
+    /**
+     * 新增码表条目
+     * @param param 码表条目修改参数
+     * @return 码表条目id
+     */
     @PostMapping("dict/entry/add")
     public Long addDictEntry(@RequestBody @Valid DictEntryModifyParam param) {
         return this.dictEntryService.addDictEntry(param);
     }
 
+    /**
+     * 根据id修改码表条目
+     * @param id 码表条目id
+     * @param param 码表条目修改参数
+     */
     @PutMapping("dict/entry/update/{id}")
     public void updateDictEntry(@PathVariable("id") @Min(value = 1, message = "id不能小于1") Long id, @RequestBody @Valid DictEntryModifyParam param) {
         this.dictEntryService.updateDictEntry(id, param);
     }
 
+    /**
+     * 根据id移除码表条目
+     * @param id 码表条目id
+     */
     @PostMapping("dict/entry/remove/{id}")
     public void removeDictItem(@PathVariable @Min(value = 1, message = "id不能小于1") Long id) {
         this.dictEntryService.removeDictEntry(id);
     }
 
+    /**
+     * 分页查询码表信息
+     */
     @GetMapping("dict/entry/page")
     public Pagination<DictEntryDTO> dictEntryPaging(@RequestBody @Valid DictPagingParam param) {
         return this.dictEntryService.dictEntryPaging(param);
     }
 
+    /**
+     * 获取所有码表信息
+     */
     @GetMapping("dict/entry/all")
     public List<List<DictEntryDTO>> dictEntryAll() {
         return this.dictEntryService.dictEntryGetAll();

src/main/java/com/chelvc/cloud/admin/controller/DictItemController.java

@@ -16,6 +16,7 @@ import javax.validation.constraints.Min;
 import java.util.List;
 
 /**
+ * 码表元素控制层
  * @author valley
  * @date 2024/01/17 00:01
  **/
@@ -28,22 +29,41 @@ public class DictItemController {
     @DubboReference
     DictItemService dictItemService;
 
+    /**
+     * 码表元素新增
+     * @param param 码表元素修改参数
+     * @return 码表元素id
+     */
     @PostMapping("dict/item/add")
     public Long addDictItem(@RequestBody @Valid DictItemModifyParam param) {
         return this.dictItemService.addDictItem(param);
     }
 
+    /**
+     * 懒加载码表条目所有元素信息
+     * @param entryId 条目id
+     * @return 元素列表
+     */
     @GetMapping("dict/item/{entryId}")
     public List<DictItemDTO> getDictItem(@PathVariable @Min(value = 1,message = "entryId不能小于1") Long entryId) {
         return this.dictItemService.getDictItem(entryId);
     }
 
+    /**
+     * 修改码表子元素信息
+     * @param id 子元素id
+     * @param param 码表元素修改参数
+     */
     @PutMapping("dict/item/update/{id}")
     public void updateDictEntry(@PathVariable("id") @Min(value = 1, message = "id不能小于1") Long id, @RequestBody @Valid DictItemModifyParam param) {
         this.dictItemService.updateDictItem(id, param);
     }
 
 
+    /**
+     * 删除码表子元素
+     * @param id 子元素id
+     */
     @PostMapping("dict/item/remove/{id}")
     public void removeDictItem(@PathVariable @Min(value = 1, message = "id不能小于1") Long id) {
          this.dictItemService.removeDictItem(id);