vue3：【post】

1. 添加 TODO 修改建议
2. 增加注释
3. 调整一些 import、const 的顺序

yudao-ui-admin-vue3/src/api/system/post/index.ts

@@ -31,6 +31,7 @@ export const deletePostApi = async (id: number) => {
 }
 
 // 导出岗位
+// TODO @星语：导出这块，咱怎么弄哈
 export const exportPostApi = async (params: PostExportReqVO) => {
   return await request.download({ url: '/system/post/export', params })
 }

yudao-ui-admin-vue3/src/api/system/post/types.ts

@@ -8,6 +8,7 @@ export type PostVO = {
   createTime?: string
 }
 
+// TODO @星语：要不要搞个 Page 基类呀？和后端对应
 export type PostPageReqVO = {
   code: string
   name: string

yudao-ui-admin-vue3/src/views/system/post/index.vue

@@ -1,6 +1,8 @@
 <template>
   <ContentWrap>
+    <!-- 列表 -->
     <vxe-grid ref="xGrid" v-bind="gridOptions" class="xtable-scrollbar">
+      <!-- 操作：新增 -->
       <template #toolbar_buttons>
         <XButton
           type="primary"
@@ -11,18 +13,21 @@
         />
       </template>
       <template #actionbtns_default="{ row }">
+        <!-- 操作：修改 -->
         <XTextButton
           preIcon="ep:edit"
           :title="t('action.edit')"
           v-hasPermi="['system:post:update']"
           @click="handleUpdate(row.id)"
         />
+        <!-- 操作：详情 -->
         <XTextButton
           preIcon="ep:view"
           :title="t('action.detail')"
           v-hasPermi="['system:post:update']"
           @click="handleDetail(row)"
         />
+        <!-- 操作：删除 -->
         <XTextButton
           preIcon="ep:delete"
           :title="t('action.del')"
@@ -32,15 +37,17 @@
       </template>
     </vxe-grid>
   </ContentWrap>
+  <!-- 弹窗 -->
   <XModal id="postModel" v-model="dialogVisible" :title="dialogTitle">
     <template #default>
-      <!-- 对话框(添加 / 修改) -->
+      <!-- 表单：添加/修改 -->
       <Form
         v-if="['create', 'update'].includes(actionType)"
         :schema="allSchemas.formSchema"
         :rules="rules"
         ref="formRef"
       />
+      <!-- 表单：详情 -->
       <Descriptions
         v-if="actionType === 'detail'"
         :schema="allSchemas.detailSchema"
@@ -48,6 +55,7 @@
       />
     </template>
     <template #footer>
+      <!-- 按钮：保存 -->
       <XButton
         v-if="['create', 'update'].includes(actionType)"
         type="primary"
@@ -55,35 +63,39 @@
         :loading="actionLoading"
         @click="submitForm"
       />
+      <!-- 按钮：关闭 -->
       <XButton :loading="actionLoading" :title="t('dialog.close')" @click="dialogVisible = false" />
     </template>
   </XModal>
 </template>
 <script setup lang="ts">
+// 全局相关的 import
 import { ref, unref } from 'vue'
-import * as PostApi from '@/api/system/post'
-import { PostVO } from '@/api/system/post/types'
-import { rules, allSchemas } from './post.data'
 import { useI18n } from '@/hooks/web/useI18n'
 import { useMessage } from '@/hooks/web/useMessage'
 import { useVxeGrid } from '@/hooks/web/useVxeGrid'
 import { VxeGridInstance } from 'vxe-table'
 import { FormExpose } from '@/components/Form'
+// 业务相关的 import
+import * as PostApi from '@/api/system/post'
+import { PostVO } from '@/api/system/post/types'
+import { rules, allSchemas } from './post.data'
 
 const { t } = useI18n() // 国际化
 const message = useMessage() // 消息弹窗
-const dialogVisible = ref(false) // 是否显示弹出层
-const dialogTitle = ref('edit') // 弹出层标题
-const actionType = ref('') // 操作按钮的类型
-const actionLoading = ref(false) // 按钮Loading
-const xGrid = ref<VxeGridInstance>() // grid Ref
-const formRef = ref<FormExpose>() // 表单 Ref
-const detailRef = ref() // 详情 Ref
-
+// 列表相关的变量
+const xGrid = ref<VxeGridInstance>() // 列表 Grid Ref
 const { gridOptions } = useVxeGrid<PostVO>({
   allSchemas: allSchemas,
   getListApi: PostApi.getPostPageApi
 })
+// 弹窗相关的变量
+const dialogVisible = ref(false) // 是否显示弹出层
+const dialogTitle = ref('edit') // 弹出层标题
+const actionType = ref('') // 操作按钮的类型
+const actionLoading = ref(false) // 按钮 Loading
+const formRef = ref<FormExpose>() // 表单 Ref
+const detailRef = ref() // 详情 Ref
 
 // 设置标题
 const setDialogTile = (type: string) => {
@@ -110,6 +122,7 @@ const handleUpdate = async (rowId: number) => {
 // 详情操作
 const handleDetail = (row: PostVO) => {
   setDialogTile('detail')
+  // TODO @星语：要不读取下后端？
   detailRef.value = row
 }
 
@@ -122,14 +135,16 @@ const handleDelete = async (rowId: number) => {
       message.success(t('common.delSuccess'))
     })
     .finally(() => {
+      // 刷新列表
       xGrid.value?.commitProxy('query')
     })
 }
 
-// 提交按钮
+// 提交新增/修改的表单
 const submitForm = async () => {
   const elForm = unref(formRef)?.getElFormRef()
   if (!elForm) return
+  // TODO @星语：这个告警，要不要解决下？
   elForm.validate(async (valid) => {
     if (valid) {
       actionLoading.value = true
@@ -146,6 +161,7 @@ const submitForm = async () => {
         dialogVisible.value = false
       } finally {
         actionLoading.value = false
+        // 刷新列表
         xGrid.value?.commitProxy('query')
       }
     }