3.0 KiB
3.0 KiB
sessionId, startTime, status
| sessionId | startTime | status |
|---|---|---|
| 20260612-1 | 2026-06-12T10:00:00+08:00 | completed |
2026-06-12 会话:Vue/TypeScript 文件中文注释补全
概要
为 mokee-gateway-web 项目的 19 个核心文件添加了详细的中文注释,包括文件头说明、逻辑块分隔、函数 JSDoc、API 调用说明、数据流说明。
已完成文件
核心配置(4 个)
- vite.config.ts — unplugin-vue-components 按需加载原理、manualChunks 分包策略、modulepreload 剥离插件机制
- src/main.ts — 最小化启动引导流程、Pinia→Router 注册顺序、v-permission 指令说明
- src/App.vue — ElConfigProvider 中文语言包全局配置
- src/utils/icons.ts — 动态图标注册表原理(解决按需导入后字符串名找不到组件)、getIconComponent 使用场景
仪表盘(1 个)
- src/views/admin/Dashboard.vue — 4 张统计卡片、ECharts 动态加载、JVM 信息面板、图表 renderChart 函数详解
日志页(2 个)
- src/views/admin/log/LoginLogList.vue — systemName 列说明、登录状态 1/0 含义、日期参数拆分逻辑
- src/views/admin/log/OperationLogList.vue — action 枚举值映射、HTTP method 颜色映射、JSON 格式化安全处理
列表视图(6 个)
- src/views/admin/system/SystemList.vue — 图标列动态渲染、v-permission 权限控制、docToken 文档跳转
- src/views/admin/user/UserList.vue — 用户分页、编辑模式路由跳转
- src/views/admin/role/RoleList.vue — 分配菜单完整流程(并行加载、半选节点处理)、systemName 连表查询
- src/views/admin/menu/MenuList.vue — 树形表格、展开/折叠递归算法、菜单表单弹窗逻辑、PUT URL 修正说明
- src/views/admin/dict/DictList.vue — 前端 dictLabel 过滤、不分页设计、新增字典类型弹窗
- src/views/admin/system/ApiList.vue — localStorage.currentSystemId 默认系统选中、method 颜色映射
表单页(4 个)
- src/views/admin/system/ApiForm.vue — query.systemId 预设、apiDesc 填充修复说明
- src/views/admin/user/UserForm.vue — 系统绑定/角色分配完整流程、系统列表端点修正说明
- src/views/admin/role/RoleForm.vue — 系统列表端点统一说明
- src/views/admin/menu/MenuForm.vue — 动态校验规则(按菜单类型)、菜单树加载顺序
选择/文档页(2 个)
- src/views/select/SystemSelectView.vue — getIconComponent 降级逻辑、gateway 跨域名跳转原理、渐变配色方案
- src/views/docs/IntegrationDoc.vue — 8 章节内容概述、menuSql/adminSql 生成逻辑、BCrypt 密码说明
注释规范
- 文件头:
<!-- -->或/** */格式,说明页面/组件用途 - 逻辑块:
// ===== 章节名 =====格式分隔 - 函数:
/** */JSDoc 格式,含 @param/@returns - 内联:
//用于 API 调用、数据转换、非显而易见逻辑 - 所有注释使用简体中文,代码逻辑未改动