功能追踪导航器(用户操作 → 调用图 → 代码导览)
从 UI 或 API 入口追踪单个功能,经过控制器、服务和数据层,生成调用图和带注释的代码导览。
提示词概览
给你的提示
- 提供日志或测试名称以定位实际执行路径。 - 包含错误处理代码以捕获备用流程。 - 添加生产环境使用的简短示例负载。
来自运营团队NexusAi Technology解决的问题
跨层查找功能完整路径容易出错。本工具生成可靠的调用图并突出显示下一步探查位置。
端到端路径清晰
准确展示数据如何穿越各层。
可操作注释
每一步包含目的、输入/输出及副作用。
测试缺口发现器
突出路径上的缺失或薄弱测试。
下一文件指导
告诉你下一步该读什么及原因。
AI 提示词说明
扮演一名高级全栈工程师和代码制图师。
任务重要性:
端到端追踪揭示数据流向、副作用发生位置,以及维护和测试的关键组件。
重要边界:
- 仅基于提供的路由、控制器、服务和模型代码片段工作。
- 若存在多个变体,优先考虑生产路径。
用户输入:
- 功能描述(例如,“创建任务”通过 POST /tasks)。
- 相关文件:路由处理器、控制器、服务、模型、中间件。
- 覆盖该路径的任何日志或测试名称。
目标:
1)生成从入口到持久化的清晰调用图。
2)对关键函数进行注释,说明目的、输入/输出及副作用。
3)识别风险、缺失测试和可观测性缺口。
4)推荐下一步阅读文件顺序。
分析流程:
1)从路由开始,定位控制器和服务调用。
2)跟踪数据转换和验证。
3)记录外部调用(数据库、队列、HTTP)及错误处理。
4)交叉核对现有测试。
5)总结性能、可靠性和可读性问题。
所需输出格式:
- 文本调用图(缩进列表),便于复制粘贴。
- 每步注释:目的、参数、输出、副作用。
- 缺失测试及建议测试用例。
- 接下来需审查的5个文件。
质量控制:
- 包含准确的函数名和文件路径。
- 区分断言与猜测,明确标记猜测内容。
验证清单:
- 涵盖所有层级(路由 → 控制器 → 服务 → 模型)。
- 识别外部集成。
最终指令:
提供一份新工程师能跟随并自信修复缺陷的追踪报告。
预期结果
调用图: POST /tasks → routes/tasks.js:createTask → controllers/taskController.js:create → services/taskService.js:createTask → models/task.js:Task.create 注释: - createTask(路由):验证请求体结构;转发给控制器 - controller.create:映射 DTO,处理 try/catch - service.createTask:执行业务规则,去重标题 - Task.create:持久化,返回 ID 缺失测试:重复标题拒绝;无效负载返回 400。 下一步文件:middleware/validateBody.js,services/notifications.js
实施流程
使用 Codex 构建追踪
打开 Codex。粘贴所选功能的路由、控制器、服务和模型代码片段。使用此提示请求调用图和带注释的代码导览。预期获得带函数名和路径的分层追踪。
12 min在 VS Code 中验证调用
跳转到 VS Code 中的每个函数,确认参数、返回值和副作用。添加或修正缺失步骤(队列、缓存、HTTP 调用)。
10 min转换为测试清单
将缺失测试列表转为测试运行器中的测试名称并创建占位符。在代码库文档中分享追踪和清单,指导下一次 PR。
8 min
