From f6f2f65656f5027f5caaf93150e72ce0c0931959 Mon Sep 17 00:00:00 2001
From: YunaiV <zhijiantianya@gmail.com>
Date: Sat, 7 Jun 2025 20:17:21 +0800
Subject: [PATCH] =?UTF-8?q?review=EF=BC=9A=E3=80=90ANTD=E3=80=91=E3=80=90B?=
 =?UTF-8?q?PM=20=E5=B7=A5=E4=BD=9C=E6=B5=81=E3=80=91ziye=20#https://gitee.?=
 =?UTF-8?q?com/yudaocode/yudao-ui-admin-vben/pulls/113?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 apps/web-antd/src/api/bpm/category/index.ts                   | 3 ++-
 apps/web-antd/src/api/bpm/definition/index.ts                 | 4 ++--
 apps/web-antd/src/api/bpm/form/index.ts                       | 4 +++-
 apps/web-antd/src/api/bpm/model/index.ts                      | 1 +
 apps/web-antd/src/api/bpm/oa/leave/index.ts                   | 1 +
 apps/web-antd/src/api/bpm/processExpression/index.ts          | 3 ++-
 apps/web-antd/src/api/bpm/processInstance/index.ts            | 3 ++-
 apps/web-antd/src/api/bpm/processListener/index.ts            | 1 +
 apps/web-antd/src/api/bpm/task/index.ts                       | 1 +
 apps/web-antd/src/api/bpm/userGroup/index.ts                  | 1 +
 .../src/components/select-modal/user-select-modal.vue         | 1 +
 apps/web-antd/src/utils/download.ts                           | 2 +-
 apps/web-antd/src/views/bpm/form/designer/index.vue           | 1 +
 apps/web-antd/src/views/bpm/form/index.vue                    | 1 +
 apps/web-antd/src/views/bpm/processExpression/index.vue       | 1 +
 apps/web-antd/src/views/bpm/processInstance/create/index.vue  | 2 ++
 .../src/views/bpm/processInstance/create/modules/form.vue     | 4 +++-
 apps/web-antd/src/views/bpm/processInstance/detail/index.vue  | 4 ++--
 .../views/bpm/processInstance/detail/modules/bpm-viewer.vue   | 1 +
 .../views/bpm/processInstance/detail/modules/signature.vue    | 2 ++
 .../views/bpm/processInstance/detail/modules/task-list.vue    | 2 +-
 apps/web-antd/src/views/bpm/processInstance/manager/index.vue | 1 +
 apps/web-antd/src/views/bpm/processListener/index.vue         | 1 +
 apps/web-antd/src/views/bpm/task/copy/index.vue               | 1 +
 apps/web-antd/src/views/bpm/task/todo/index.vue               | 1 +
 25 files changed, 36 insertions(+), 11 deletions(-)

diff --git a/apps/web-antd/src/api/bpm/category/index.ts b/apps/web-antd/src/api/bpm/category/index.ts
index 4b509d298..d622183f0 100644
--- a/apps/web-antd/src/api/bpm/category/index.ts
+++ b/apps/web-antd/src/api/bpm/category/index.ts
@@ -3,7 +3,8 @@ import type { PageParam, PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace BpmCategoryApi {
-  /** BPM 流程分类 VO */
+  /** 流程分类 VO */
+  // TODO @jason：不用 VO 后缀哈
   export interface CategoryVO {
     id: number;
     name: string;
diff --git a/apps/web-antd/src/api/bpm/definition/index.ts b/apps/web-antd/src/api/bpm/definition/index.ts
index 795caa1b5..b7e22bea9 100644
--- a/apps/web-antd/src/api/bpm/definition/index.ts
+++ b/apps/web-antd/src/api/bpm/definition/index.ts
@@ -2,9 +2,9 @@ import type { PageParam, PageResult } from '@vben/request';
 
 import { requestClient } from '#/api/request';
 
-/** 流程定义 */
 export namespace BpmProcessDefinitionApi {
-  // 流程定义
+  /** 流程定义 */
+  // TODO @ziye：不用 VO 后缀哈
   export interface ProcessDefinitionVO {
     id: string;
     version: number;
diff --git a/apps/web-antd/src/api/bpm/form/index.ts b/apps/web-antd/src/api/bpm/form/index.ts
index 78ce4d6d3..1c14a67e8 100644
--- a/apps/web-antd/src/api/bpm/form/index.ts
+++ b/apps/web-antd/src/api/bpm/form/index.ts
@@ -3,7 +3,8 @@ import type { PageParam, PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace BpmFormApi {
-  // 流程表单
+  /** 流程表单 */
+  // TODO @jason：不用 VO 后缀哈
   export interface FormVO {
     id?: number | undefined;
     name: string;
@@ -23,6 +24,7 @@ export async function getFormPage(params: PageParam) {
 }
 
 /** 获取表单详情 */
+// TODO @ziye：应该不会 string 的情况呢。
 export async function getFormDetail(id: number | string) {
   return requestClient.get<BpmFormApi.FormVO>(`/bpm/form/get?id=${id}`);
 }
diff --git a/apps/web-antd/src/api/bpm/model/index.ts b/apps/web-antd/src/api/bpm/model/index.ts
index 455981782..655cfb034 100644
--- a/apps/web-antd/src/api/bpm/model/index.ts
+++ b/apps/web-antd/src/api/bpm/model/index.ts
@@ -12,6 +12,7 @@ export namespace BpmModelApi {
   }
 
   /** 流程定义 VO */
+  // TODO @jason：不用 VO 后缀哈
   export interface ProcessDefinitionVO {
     id: string;
     key?: string;
diff --git a/apps/web-antd/src/api/bpm/oa/leave/index.ts b/apps/web-antd/src/api/bpm/oa/leave/index.ts
index 4172ffbd0..90f6e2602 100644
--- a/apps/web-antd/src/api/bpm/oa/leave/index.ts
+++ b/apps/web-antd/src/api/bpm/oa/leave/index.ts
@@ -3,6 +3,7 @@ import type { PageParam, PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace BpmOALeaveApi {
+  // TODO @ziye：不用 VO 后缀
   export interface LeaveVO {
     id: number;
     status: number;
diff --git a/apps/web-antd/src/api/bpm/processExpression/index.ts b/apps/web-antd/src/api/bpm/processExpression/index.ts
index 9444dd26e..3408c38c3 100644
--- a/apps/web-antd/src/api/bpm/processExpression/index.ts
+++ b/apps/web-antd/src/api/bpm/processExpression/index.ts
@@ -3,7 +3,8 @@ import type { PageParam, PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace BpmProcessExpressionApi {
-  /** BPM 流程表达式 VO */
+  // TODO @ziye：不用 VO 后缀
+  /** 流程表达式 VO */
   export interface ProcessExpressionVO {
     id: number; // 编号
     name: string; // 表达式名字
diff --git a/apps/web-antd/src/api/bpm/processInstance/index.ts b/apps/web-antd/src/api/bpm/processInstance/index.ts
index 4f9b77959..67a6d9cf6 100644
--- a/apps/web-antd/src/api/bpm/processInstance/index.ts
+++ b/apps/web-antd/src/api/bpm/processInstance/index.ts
@@ -8,6 +8,7 @@ import type { BpmCandidateStrategyEnum, BpmNodeTypeEnum } from '#/utils';
 import { requestClient } from '#/api/request';
 
 export namespace BpmProcessInstanceApi {
+  // TODO @芋艿：一些注释缺少或者不对；
   export type Task = {
     id: number;
     name: string;
@@ -42,7 +43,7 @@ export namespace BpmProcessInstanceApi {
     tasks: ApprovalTaskInfo[];
   };
 
-  // 流程实例
+  /** 流程实例 */
   export type ProcessInstanceVO = {
     businessKey: string;
     category: string;
diff --git a/apps/web-antd/src/api/bpm/processListener/index.ts b/apps/web-antd/src/api/bpm/processListener/index.ts
index 8d5c05c93..8d93107ac 100644
--- a/apps/web-antd/src/api/bpm/processListener/index.ts
+++ b/apps/web-antd/src/api/bpm/processListener/index.ts
@@ -3,6 +3,7 @@ import type { PageParam, PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace BpmProcessListenerApi {
+  // TODO @ziye：不用 VO 后缀
   /** BPM 流程监听器 VO */
   export interface ProcessListenerVO {
     id: number; // 编号
diff --git a/apps/web-antd/src/api/bpm/task/index.ts b/apps/web-antd/src/api/bpm/task/index.ts
index 19cbede85..89a8ceede 100644
--- a/apps/web-antd/src/api/bpm/task/index.ts
+++ b/apps/web-antd/src/api/bpm/task/index.ts
@@ -5,6 +5,7 @@ import type { BpmProcessInstanceApi } from '../processInstance';
 import { requestClient } from '#/api/request';
 
 export namespace BpmTaskApi {
+  // TODO @ziye：不用 VO 后缀；注释使用 /** */ 风格；
   /** BPM 流程监听器 VO */
   export interface TaskVO {
     id: number; // 编号
diff --git a/apps/web-antd/src/api/bpm/userGroup/index.ts b/apps/web-antd/src/api/bpm/userGroup/index.ts
index f4c50f8b0..bae30827e 100644
--- a/apps/web-antd/src/api/bpm/userGroup/index.ts
+++ b/apps/web-antd/src/api/bpm/userGroup/index.ts
@@ -3,6 +3,7 @@ import type { PageParam, PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';
 
 export namespace BpmUserGroupApi {
+  // TODO @ziye：不用 VO 后缀
   /** BPM 用户组 VO */
   export interface UserGroupVO {
     id: number;
diff --git a/apps/web-antd/src/components/select-modal/user-select-modal.vue b/apps/web-antd/src/components/select-modal/user-select-modal.vue
index 23fce5aec..86d44d25f 100644
--- a/apps/web-antd/src/components/select-modal/user-select-modal.vue
+++ b/apps/web-antd/src/components/select-modal/user-select-modal.vue
@@ -1,5 +1,6 @@
 <script lang="ts" setup>
 // TODO @芋艿：是否有更好的组织形式？！
+// TODO @xingyu：你感觉，这个放到每个 system、infra 模块下，然后新建一个 components，表示每个模块，有一些共享的组件？然后，全局只放通用的（无业务含义的），可以哇？
 import type { Key } from 'ant-design-vue/es/table/interface';
 
 import type { SystemDeptApi } from '#/api/system/dept';
diff --git a/apps/web-antd/src/utils/download.ts b/apps/web-antd/src/utils/download.ts
index f7cf56596..e50f2997d 100644
--- a/apps/web-antd/src/utils/download.ts
+++ b/apps/web-antd/src/utils/download.ts
@@ -2,7 +2,7 @@
  * 下载工具模块
  * 提供多种文件格式的下载功能
  */
-// 请使用 @vben/utils/download 代替 packages/@core/base/shared/src/utils/download.ts
+// TODO @ziye：请使用 @vben/utils/download 代替 packages/@core/base/shared/src/utils/download.ts
 
 /**
  * 图片下载配置接口
diff --git a/apps/web-antd/src/views/bpm/form/designer/index.vue b/apps/web-antd/src/views/bpm/form/designer/index.vue
index a594106e5..b270b9fe0 100644
--- a/apps/web-antd/src/views/bpm/form/designer/index.vue
+++ b/apps/web-antd/src/views/bpm/form/designer/index.vue
@@ -106,6 +106,7 @@ async function initializeDesigner() {
   }
 }
 
+// TODO @ziye：注释使用 /** */ 风格，高亮更明显哈，方法注释；
 // 保存表单
 function handleSave() {
   formModalApi
diff --git a/apps/web-antd/src/views/bpm/form/index.vue b/apps/web-antd/src/views/bpm/form/index.vue
index 8bf9608de..1f8bac4a9 100644
--- a/apps/web-antd/src/views/bpm/form/index.vue
+++ b/apps/web-antd/src/views/bpm/form/index.vue
@@ -138,6 +138,7 @@ watch(
         url="https://doc.iocoder.cn/bpm/use-bpm-form/"
       />
     </template>
+
     <DetailModal />
     <Grid table-title="流程表单">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/bpm/processExpression/index.vue b/apps/web-antd/src/views/bpm/processExpression/index.vue
index 9d5c08bab..754b403fa 100644
--- a/apps/web-antd/src/views/bpm/processExpression/index.vue
+++ b/apps/web-antd/src/views/bpm/processExpression/index.vue
@@ -93,6 +93,7 @@ const [Grid, gridApi] = useVbenVxeGrid({
         url="https://doc.iocoder.cn/bpm/expression/"
       />
     </template>
+
     <FormModal @success="onRefresh" />
     <Grid table-title="流程表达式">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/bpm/processInstance/create/index.vue b/apps/web-antd/src/views/bpm/processInstance/create/index.vue
index dfe0bf8a2..313d77ff1 100644
--- a/apps/web-antd/src/views/bpm/processInstance/create/index.vue
+++ b/apps/web-antd/src/views/bpm/processInstance/create/index.vue
@@ -222,6 +222,7 @@ onMounted(() => {
 
 <template>
   <Page auto-content-height>
+    <!-- TODO @ziye：【优先级：低】这里交互，可以做成类似 vue3 + element-plus 那个一样，滚动切换分类哈？对标钉钉、飞书哈； -->
     <!-- 第一步，通过流程定义的列表，选择对应的流程 -->
     <template v-if="!selectProcessDefinition">
       <Card
@@ -274,6 +275,7 @@ onMounted(() => {
                     }"
                   >
                     <div class="flex items-center">
+                      <!-- TODO @ziye：icon、name 会告警~~ -->
                       <img
                         v-if="definition.icon"
                         :src="definition.icon"
diff --git a/apps/web-antd/src/views/bpm/processInstance/create/modules/form.vue b/apps/web-antd/src/views/bpm/processInstance/create/modules/form.vue
index 617a35cfa..b59c0f009 100644
--- a/apps/web-antd/src/views/bpm/processInstance/create/modules/form.vue
+++ b/apps/web-antd/src/views/bpm/processInstance/create/modules/form.vue
@@ -28,7 +28,8 @@ import {
 } from '#/utils';
 import ProcessInstanceSimpleViewer from '#/views/bpm/processInstance/detail/modules/simple-bpm-viewer.vue';
 import ProcessInstanceTimeline from '#/views/bpm/processInstance/detail/modules/time-line.vue';
-// 类型定义
+
+/** 类型定义 */
 interface ProcessFormData {
   rule: any[];
   option: Record<string, any>;
@@ -121,6 +122,7 @@ async function submitForm() {
 
     message.success('发起流程成功');
 
+    // TODO @ziye：有告警哈；
     closeCurrentTab();
 
     await router.push({ path: '/bpm/task/my' });
diff --git a/apps/web-antd/src/views/bpm/processInstance/detail/index.vue b/apps/web-antd/src/views/bpm/processInstance/detail/index.vue
index f3ff8efdd..40a03e637 100644
--- a/apps/web-antd/src/views/bpm/processInstance/detail/index.vue
+++ b/apps/web-antd/src/views/bpm/processInstance/detail/index.vue
@@ -222,7 +222,7 @@ function setFieldPermission(field: string, permission: string) {
 const activeTab = ref('form');
 const taskListRef = ref();
 
-// 监听 Tab 切换，当切换到 "record" 标签时刷新任务列表
+/** 监听 Tab 切换，当切换到 "record" 标签时刷新任务列表 */
 watch(
   () => activeTab.value,
   (newVal) => {
@@ -238,7 +238,7 @@ watch(
 /** 初始化 */
 const userOptions = ref<SystemUserApi.User[]>([]); // 用户列表
 onMounted(async () => {
-  getDetail();
+  await getDetail();
   // 获得用户列表
   userOptions.value = await getSimpleUserList();
 });
diff --git a/apps/web-antd/src/views/bpm/processInstance/detail/modules/bpm-viewer.vue b/apps/web-antd/src/views/bpm/processInstance/detail/modules/bpm-viewer.vue
index 127caca6c..aa3a33641 100644
--- a/apps/web-antd/src/views/bpm/processInstance/detail/modules/bpm-viewer.vue
+++ b/apps/web-antd/src/views/bpm/processInstance/detail/modules/bpm-viewer.vue
@@ -3,6 +3,7 @@ defineOptions({ name: 'ProcessInstanceBpmnViewer' });
 </script>
 
 <template>
+  <!-- TODO @ziye：可以后续，找下 antd 有没可以直接用的组件哈 -->
   <div>
     <h1>BPMN Viewer</h1>
   </div>
diff --git a/apps/web-antd/src/views/bpm/processInstance/detail/modules/signature.vue b/apps/web-antd/src/views/bpm/processInstance/detail/modules/signature.vue
index 7f4091538..82d7dfd60 100644
--- a/apps/web-antd/src/views/bpm/processInstance/detail/modules/signature.vue
+++ b/apps/web-antd/src/views/bpm/processInstance/detail/modules/signature.vue
@@ -5,6 +5,7 @@ import { useVbenModal } from '@vben/common-ui';
 import { IconifyIcon } from '@vben/icons';
 
 import { Button, message, Space, Tooltip } from 'ant-design-vue';
+// TODO @ziye：这个可能，适合放到全局？！因为 element-plus 也用这个；
 import Vue3Signature from 'vue3-signature';
 
 import { uploadFile } from '#/api/infra/file';
@@ -36,6 +37,7 @@ const [Modal, modalApi] = useVbenModal({
       ),
     });
     emits('success', signFileUrl);
+    // TODO @ziye：下面有个告警哈；ps：所有告警，皆是错误，可以关注 ide 给的提示哈；
     modalApi.close();
   },
 });
diff --git a/apps/web-antd/src/views/bpm/processInstance/detail/modules/task-list.vue b/apps/web-antd/src/views/bpm/processInstance/detail/modules/task-list.vue
index 199d33863..aa6727ac7 100644
--- a/apps/web-antd/src/views/bpm/processInstance/detail/modules/task-list.vue
+++ b/apps/web-antd/src/views/bpm/processInstance/detail/modules/task-list.vue
@@ -25,7 +25,7 @@ const props = defineProps<{
   loading: boolean;
 }>();
 
-// 使用shallowRef减少不必要的深度响应
+// 使用 shallowRef 减少不必要的深度响应
 const columns = shallowRef([
   {
     field: 'name',
diff --git a/apps/web-antd/src/views/bpm/processInstance/manager/index.vue b/apps/web-antd/src/views/bpm/processInstance/manager/index.vue
index 2122dbd79..4c4e8766c 100644
--- a/apps/web-antd/src/views/bpm/processInstance/manager/index.vue
+++ b/apps/web-antd/src/views/bpm/processInstance/manager/index.vue
@@ -14,6 +14,7 @@ import {
   getProcessInstanceManagerPage,
 } from '#/api/bpm/processInstance';
 import { DocAlert } from '#/components/doc-alert';
+import { $t } from '#/locales';
 import { router } from '#/router';
 import { BpmProcessInstanceStatus } from '#/utils';
 
diff --git a/apps/web-antd/src/views/bpm/processListener/index.vue b/apps/web-antd/src/views/bpm/processListener/index.vue
index 916f8c190..10566c712 100644
--- a/apps/web-antd/src/views/bpm/processListener/index.vue
+++ b/apps/web-antd/src/views/bpm/processListener/index.vue
@@ -93,6 +93,7 @@ const [Grid, gridApi] = useVbenVxeGrid({
         url="https://doc.iocoder.cn/bpm/listener/"
       />
     </template>
+
     <FormModal @success="onRefresh" />
     <Grid table-title="流程监听器">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/bpm/task/copy/index.vue b/apps/web-antd/src/views/bpm/task/copy/index.vue
index 74edec4de..a7ff04581 100644
--- a/apps/web-antd/src/views/bpm/task/copy/index.vue
+++ b/apps/web-antd/src/views/bpm/task/copy/index.vue
@@ -7,6 +7,7 @@ import { Page } from '@vben/common-ui';
 import { ACTION_ICON, TableAction, useVbenVxeGrid } from '#/adapter/vxe-table';
 import { getProcessInstanceCopyPage } from '#/api/bpm/processInstance';
 import { DocAlert } from '#/components/doc-alert';
+import { $t } from '#/locales';
 import { router } from '#/router';
 
 import { useGridColumns, useGridFormSchema } from './data';
diff --git a/apps/web-antd/src/views/bpm/task/todo/index.vue b/apps/web-antd/src/views/bpm/task/todo/index.vue
index d13e511b2..59c7f71b7 100644
--- a/apps/web-antd/src/views/bpm/task/todo/index.vue
+++ b/apps/web-antd/src/views/bpm/task/todo/index.vue
@@ -72,6 +72,7 @@ const [Grid] = useVbenVxeGrid({
       />
       <DocAlert title="审批加签、减签" url="https://doc.iocoder.cn/bpm/sign/" />
     </template>
+
     <Grid table-title="待办任务">
       <template #actions="{ row }">
         <TableAction