Files
ApiServer-Web-admin_dashboa…/审查代码提示词.MD
T
lin 2f06aa9f5f
Build and Deploy Vue3 / build (push) Successful in 1m51s
Build and Deploy Vue3 / deploy (push) Successful in 1m15s
style: 优化布局和交互(Loading/空状态/骨架屏)
2026-04-07 16:51:12 +08:00

64 lines
4.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
要让 Cursor 能够高效地完成这项复杂任务,你需要将“需求”转化为“结构化指令”。不要一次性丢给它所有任务,建议按照**“调研-分析-开发-优化”**的逻辑分阶段进行。
以下是为你设计的 **Prompt 模板**,你可以根据实际情况稍作修改:
---
### 第一阶段:现状分析与评估(核心提示词)
**使用场景:**`openapi.json` 拖入 Cursor,打开你的项目根目录,发送以下 Prompt:
> **Prompt:**
> 我现在正在对接用户商品管理模块,API 定义在 `@ApiServer-web-admin_dashboard_pc/默认模块.openapi.json` 中。
>
> 请你执行以下任务:
> 1. **接口完整性对比:** 分析该 OpenAPI 文件中所有以 `/product` 或 `user` 开头的接口。对比我当前项目中 `src/api/product.ts`(或对应目录)的实现,列出缺少实现的接口、参数定义不一致的接口。
> 2. **逻辑可行性判断:** 检查这些接口的请求方式、入参结构和响应字段,判断是否存在潜在的逻辑错误(如字段类型不匹配、缺失必要的分页参数等)。
> 3. **输出报告:** 请整理出一份表格,列出:接口路径 | 功能描述 | 是否已实现 | 潜在风险/待修复点。
>
> 请先完成这一步,不要急于写代码。
---
### 第二阶段:功能开发与组件化(架构层)
**使用场景:** 在第一阶段确认无误后,让 Cursor 介入代码实现。
> **Prompt:**
> 基于上一步的分析结果,我们需要进行代码落地。请遵循以下工程化标准:
> 1. **请求实现:** 按照我现有项目的请求风格,补全缺失的接口请求函数。
> 2. **组件化拆分:** 在实现业务页面时,请评估哪些逻辑可以抽离为公共组件(例如:商品详情预览框、批量操作栏、规格选择器)。如果某个功能在多个页面有重复逻辑,请将其提取为独立的 Component,并说明该组件的 Props 定义。
> 3. **嵌套与快捷入口:** 针对“商品管理”模块,请思考是否存在需要嵌套展示的功能(如:点击列表行展开详细信息,或弹窗式管理)。如果是,请直接使用 (当前使用的框架) 的组件来实现这种交互,并保证良好的用户体验。
---
### 第三阶段:样式与交互优化(视觉层)
**使用场景:** 页面雏形出来后,让 Cursor 优化细节。
> **Prompt:**
> 现在页面已经实现了基本功能,请重点优化 UX/UI:
> 1. **布局优化:** 请检查当前的表格布局,确保字段对齐合理、间距符合 Material Design 或 Ant Design 标准。
> 2. **交互美化:** 增加必要的 Loading 状态、空状态(Empty Data)、操作反馈(Toast/Message)。
> 3. **响应式评估:** 检查该 Dashboard 页面在不同分辨率下的表现,是否需要将部分复杂的筛选表单折叠到“高级筛选”面板中,以保持界面整洁。
> 4. **视觉建议:** 请评估当前样式是否过于简单,建议增加一些层级感(例如卡片式布局、阴影、不同层级的按钮样式)。
---
### 给 Cursor 的“提效秘诀”(必读):
为了让 Cursor 表现得更好,请务必配合以下操作:
1. **利用 `@Codebase`** 在 Prompt 中提到 `@Codebase`,让 Cursor 全局检索你的代码规范(例如:你以前写的 `api` 请求是怎么写的,`component` 是怎么封装的),这样它生成的代码才不会“违和”。
2. **小步快跑:** 如果 API 接口很多(比如超过 10 个),**千万不要**让它一次性全写完。一次让它写 2-3 个接口或一个组件,改完一个确认一个。
3. **强制提供 Interface** 在提示词中加上一句:“请确保所有接口请求和响应都定义了对应的 `TypeScript Interface`,严禁使用 `any` 类型。”
4. **指定参考文件:** 如果你有已经写好的“完美的页面”,在对话框中输入 `#` 引用该文件,告诉 Cursor:“请参照 `src/pages/TemplatePage.tsx` 的代码规范和交互逻辑来实现商品管理页面。”
### 总结你的检查清单(作为你的最终验收标准):
* [ ] OpenAPI 定义的字段是否全覆盖?
* [ ] 是否每个接口都写了 try-catch 或统一的错误处理?
* [ ] 是否有复用性强的组件?(避免重复代码)
* [ ] 是否有交互反馈?(Loading/Success Tips
* [ ] 样式是否统一?(使用了全局定义的颜色/间距变量)
如果你直接丢给它一个庞大的任务,Cursor 往往会产生“幻觉”或者代码质量下降,**分步骤引导**是使用 AI 开发复杂后台的最佳实践。