chore-增加必要注释

ximatai · Nov 12, 2024 · 46a733f · 46a733f
1 parent d46bbfb
commit 46a733f
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 19 deletions.
diff --git a/...-platform/src/main/java/net/ximatai/muyun/platform/controller/ModuleActionController.java b/...-platform/src/main/java/net/ximatai/muyun/platform/controller/ModuleActionController.java
@@ -32,12 +32,12 @@ public String getMainTable() {
     public void fitOut(TableWrapper wrapper) {
         wrapper
             .setPrimaryKey(Column.ID_POSTGRES)
-            .addColumn("id_at_app_module")
-            .addColumn("v_name")
-            .addColumn("v_alias")
-            .addColumn("v_remark")
-            .addColumn(Column.of("b_white").setDefaultValue(false))
-            .addColumn("i_order")
+            .addColumn("id_at_app_module", "模块id")
+            .addColumn("v_name", "功能名称")
+            .addColumn("v_alias", "功能标识")
+            .addColumn("v_remark", "备注")
+            .addColumn("b_white", "是否白名单", false)
+            .addColumn("i_order", "序号")
             .addIndex(List.of("id_at_app_module", "v_alias"), true);
     }
 

diff --git a/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/ModuleController.java b/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/ModuleController.java
@@ -60,11 +60,11 @@ public void fitOut(TableWrapper wrapper) {
         wrapper
             .setPrimaryKey(Column.ID_POSTGRES)
             .setInherit(BaseBusinessTable.TABLE)
-            .addColumn("v_name")
+            .addColumn("v_name", "模块名称")
             .addColumn("v_alias", "模块标识，同后端Controller拦截入口名")
             .addColumn("v_url", "前端路径")
-            .addColumn("v_remark")
-            .addColumn("v_table")
+            .addColumn("v_remark", "备注")
+            .addColumn("v_table", "模块主表")
             .addColumn(Column.of("b_system").setDefaultValue(false))
             .addColumn(Column.of("b_isolation").setComment("是否启用数据隔离").setDefaultValue(false))
             .addIndex("v_alias");

diff --git a/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/NoticeController.java b/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/NoticeController.java
@@ -144,7 +144,7 @@ private void broadcast(String id) {
 
         MuYunMessage message = new MuYunMessage(
             "收到新通知啦",
-            "%s 刚刚发布了《%s》的通知".formatted(map.get("v_name_from"), map.get("v_title")),
+            "%s 刚刚发布了题为「%s」的通知".formatted(map.get("v_name_from"), map.get("v_title")),
             ""
         );
 

diff --git a/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/RoleActionController.java b/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/RoleActionController.java
@@ -4,7 +4,6 @@
 import jakarta.inject.Inject;
 import net.ximatai.muyun.ability.IChildAbility;
 import net.ximatai.muyun.ability.curd.std.IQueryAbility;
-import net.ximatai.muyun.base.BaseBusinessTable;
 import net.ximatai.muyun.database.builder.Column;
 import net.ximatai.muyun.database.builder.TableWrapper;
 import net.ximatai.muyun.model.QueryItem;
@@ -38,14 +37,13 @@ public String getMainTable() {
     public void fitOut(TableWrapper wrapper) {
         wrapper
             .setPrimaryKey(Column.ID_POSTGRES)
-            .setInherit(BaseBusinessTable.TABLE)
-            .addColumn("id_at_auth_role")
-            .addColumn("id_at_app_module")
+            .addColumn("id_at_auth_role", "角色id")
+            .addColumn("id_at_app_module", "模块id")
             .addColumn("v_alias_at_app_module", "冗余：模块别名")
-            .addColumn("id_at_app_module_action")
+            .addColumn("id_at_app_module_action", "模块id")
             .addColumn("v_alias_at_app_module_action", "冗余：功能别名")
-            .addColumn("dict_data_auth")
-            .addColumn("v_custom_condition")
+            .addColumn("dict_data_auth", "数据权限字典")
+            .addColumn("v_custom_condition", "自定义权限条件")
             .addIndex("id_at_auth_role")
             .addIndex("id_at_app_module_action")
             .addIndex(List.of("id_at_auth_role", "id_at_app_module_action"), true)

diff --git a/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/UserRoleController.java b/muyun-platform/src/main/java/net/ximatai/muyun/platform/controller/UserRoleController.java
@@ -24,8 +24,8 @@ public String getMainTable() {
     public void fitOut(TableWrapper wrapper) {
         wrapper
             .setPrimaryKey(Column.ID_POSTGRES)
-            .addColumn(Column.of("id_at_auth_user").setNullable(false))
-            .addColumn(Column.of("id_at_auth_role").setNullable(false))
+            .addColumn(Column.of("id_at_auth_user").setNullable(false).setComment("用户id"))
+            .addColumn(Column.of("id_at_auth_role").setNullable(false).setComment("角色id"))
             .addIndex(List.of("id_at_auth_user", "id_at_auth_role"), true);
     }