Tạo chú thích ngắn, đúng chức năng cho hàm và class công khai để người dùng nội bộ hiểu cách gọi, tham số, giá trị trả về và lỗi.
Điền thông tin của bạn
Prompt
Bạn là biên tập viên tài liệu kỹ thuật cho mã nguồn nội bộ. Hãy đọc danh sách API công khai và quy ước tài liệu được cung cấp, rồi viết chú thích ngắn gọn nhưng đủ dùng cho từng hàm hoặc class khó hiểu. Mục tiêu là giúp người đọc hiểu đúng mục đích, cách dùng, đầu vào, đầu ra và các điều kiện lỗi mà không làm dài dòng. Với mỗi mục, hãy dựa trên hành vi thực tế của API, tránh suy đoán quá mức, và giữ văn phong nhất quán với tài liệu hiện có. Đầu vào gồm {{danh_sach_api}}, {{quy_uoc_tai_lieu}}, {{ngon_ngu_dau_ra}}. Hãy tạo phần mô tả cho từng API theo cấu trúc rõ ràng: mục đích, tham số quan trọng, giá trị trả về, ngoại lệ hoặc trạng thái lỗi, và ghi chú sử dụng nếu cần. Nếu có chỗ chưa chắc chắn từ dữ liệu đầu vào, hãy đánh dấu để người bảo trì xác minh thay vì tự bịa. Ưu tiên câu ngắn, chính xác, không lặp từ, và phù hợp để chèn trực tiếp vào mã hoặc file tài liệu nội bộ.
danh_sach_api: ["createUser(name, email)", "deleteSession(sessionId)"]
quy_uoc_tai_lieu: "Mỗi mục gồm mục đích, tham số, trả về, lỗi"
gon_ngu_dau_ra: "vi"
Output mẫu
createUser(name, email): Tạo tài khoản người dùng mới từ tên và email. Tham số: name là tên hiển thị; email là địa chỉ dùng để định danh. Trả về: đối tượng người dùng vừa tạo. Lỗi: ném lỗi nếu email đã tồn tại hoặc dữ liệu không hợp lệ.
deleteSession(sessionId): Xóa phiên đăng nhập theo mã phiên. Tham số: sessionId là định danh phiên cần hủy. Trả về: true nếu xóa thành công. Lỗi: ném lỗi nếu sessionId không tồn tại hoặc phiên đã hết hạn.
Cách sử dụng
Điền đúng danh sách API, quy ước tài liệu và ngôn ngữ đầu ra. Dán prompt vào Codex hoặc công cụ hỗ trợ viết tài liệu mã nguồn, rồi kiểm tra lại từng chú thích xem có khớp hành vi hàm và chuẩn nội bộ hay không.
Giải thích cấu trúc
Role: prompt giao vai trò biên tập viên tài liệu kỹ thuật. Context: repository có nhiều API công khai thiếu mô tả rõ, cần chuẩn hóa tài liệu nội bộ. Task: viết chú thích ngắn cho từng hàm/class dựa trên đầu vào. Constraints: không suy đoán quá mức, phải nêu tham số, trả về, lỗi và đánh dấu điểm chưa chắc chắn. Output: mô tả có thể chèn trực tiếp vào tài liệu hoặc mã nguồn.
Mẹo sử dụng
Cung cấp danh sách API theo đúng chữ ký để mô tả bám sát thực tế.
Nêu rõ quy ước hiện tại của dự án để tránh lệch phong cách tài liệu.
Nếu có API mơ hồ, yêu cầu đánh dấu phần cần xác minh thay vì đoán.
Nguồn và giấy phép
ONTER biên tập · original
Đánh giá prompt
Chọn số sao theo trải nghiệm của bạn. Bạn có thể sửa đánh giá sau một phút.
