Trình Dẫn Đường Theo Dõi Tính Năng (Hành Động Người Dùng → Đồ Thị Gọi Hàm → Giải Thích Mã Nguồn)
Theo dõi một tính năng từ điểm nhập UI hoặc API qua các controller, service và lớp dữ liệu để tạo ra đồ thị gọi hàm và giải thích mã nguồn có chú thích.
Tổng quan prompt
Mẹo dành cho bạn
- Cung cấp log hoặc tên bài kiểm thử để xác định chính xác đường đi thực thi. - Bao gồm mã xử lý lỗi để nắm bắt các luồng thay thế. - Thêm một payload mẫu ngắn được sử dụng trong sản xuất.
Từ đội ngũ vận hànhNexusAi TechnologyVấn đề được giải quyết
Việc tìm đường đi hoàn chỉnh của một tính năng qua các lớp rất dễ sai sót. Công cụ này tạo ra đồ thị gọi hàm đáng tin cậy và làm nổi bật nơi cần khảo sát tiếp theo.
Độ Rõ Ràng Đường Đi Đầu-cuối
Hiển thị chính xác cách dữ liệu di chuyển qua các lớp.
Chú Thích Có Thể Hành Động
Mỗi bước bao gồm mục đích, đầu vào/đầu ra và tác dụng phụ.
Tìm Khoảng Trống Kiểm Thử
Làm nổi bật các kiểm thử còn thiếu hoặc yếu dọc theo đường đi.
Hướng Dẫn File Tiếp Theo
Chỉ cho bạn biết nên đọc gì tiếp theo và lý do.
Hướng dẫn prompt AI
Hãy đóng vai một kỹ sư full-stack cao cấp kiêm chuyên gia bản đồ mã nguồn.
Tại sao nhiệm vụ này quan trọng:
Các bản theo dõi đầu-cuối tiết lộ cách dữ liệu di chuyển, nơi xảy ra các tác dụng phụ, và những thành phần nào quan trọng cho việc bảo trì và kiểm thử.
Giới hạn quan trọng:
- Chỉ làm việc dựa trên các đoạn mã route, controller, service và model được cung cấp.
- Nếu có nhiều biến thể, ưu tiên đường dẫn sản xuất.
Đầu vào của người dùng:
- Mô tả tính năng (ví dụ: “Tạo Task” qua POST /tasks).
- Các file liên quan: bộ xử lý route, controller, service, model, middleware.
- Bất kỳ log hoặc tên bài kiểm thử nào bao phủ đường đi này.
Mục tiêu:
1) Tạo đồ thị gọi hàm rõ ràng từ điểm nhập đến lưu trữ.
2) Chú thích các hàm chính với mục đích, đầu vào/đầu ra và tác dụng phụ.
3) Xác định rủi ro, thiếu sót kiểm thử và khoảng trống quan sát.
4) Đề xuất thứ tự file tiếp theo cần đọc.
Quy trình phân tích:
1) Bắt đầu từ route; xác định các cuộc gọi controller và service.
2) Theo dõi các biến đổi dữ liệu và xác thực.
3) Ghi chú các cuộc gọi bên ngoài (DB, hàng đợi, HTTP) và xử lý lỗi.
4) Đối chiếu với các bài kiểm thử hiện có.
5) Tóm tắt các vấn đề về hiệu năng, độ tin cậy và khả năng đọc.
Định dạng đầu ra yêu cầu:
- Đồ thị gọi hàm dạng văn bản (danh sách thụt lề) để dễ sao chép/dán.
- Chú thích từng bước: mục đích, tham số, đầu ra, tác dụng phụ.
- Các bài kiểm thử còn thiếu và đề xuất.
- 5 file tiếp theo cần xem xét.
Kiểm soát chất lượng:
- Bao gồm tên hàm và đường dẫn file chính xác.
- Phân biệt rõ ràng giữa khẳng định và phỏng đoán; đánh dấu phỏng đoán rõ ràng.
Danh sách kiểm tra xác minh:
- Tất cả các lớp được thể hiện đầy đủ (route → controller → service → model).
- Các tích hợp bên ngoài được xác định.
Hướng dẫn cuối cùng:
Cung cấp một bản theo dõi mà kỹ sư mới có thể theo dõi để tự tin thực hiện sửa lỗi.
Kết quả kỳ vọng
Đồ Thị Gọi Hàm: POST /tasks → routes/tasks.js:createTask → controllers/taskController.js:create → services/taskService.js:createTask → models/task.js:Task.create Chú Thích: - createTask (route): Xác thực schema body; chuyển tiếp đến controller - controller.create: Ánh xạ DTO, xử lý try/catch - service.createTask: Thực thi quy tắc nghiệp vụ, loại bỏ trùng tiêu đề - Task.create: Lưu trữ, trả về id Thiếu Kiểm Thử: Từ chối tiêu đề trùng; payload không hợp lệ trả về 400. File Tiếp Theo: middleware/validateBody.js, services/notifications.js
Hành trình triển khai
Xây dựng bản theo dõi với Codex
Mở Codex. Dán các đoạn mã route, controller, service và model của tính năng đã chọn. Yêu cầu tạo đồ thị gọi hàm và giải thích có chú thích bằng prompt này. Mong đợi một bản theo dõi phân lớp với tên hàm và đường dẫn.
12 minXác thực các cuộc gọi trong VS Code
Đi đến từng hàm trong VS Code và xác nhận tham số, giá trị trả về và tác dụng phụ. Thêm hoặc chỉnh sửa các bước thiếu (hàng đợi, bộ nhớ đệm, cuộc gọi HTTP).
10 minChuyển thành danh sách kiểm thử
Biến danh sách kiểm thử thiếu thành tên bài kiểm thử trong trình chạy kiểm thử của bạn và tạo các chỗ giữ chỗ. Chia sẻ bản theo dõi và danh sách kiểm thử trong tài liệu repo để hướng dẫn PR tiếp theo.
8 min