Hướng dẫn dùng AI

Prompt đặt tên biến và hàm rõ nghĩa, nhất quán

Tên tốt diễn đạt vai trò trong đúng phạm vi, không phải càng dài càng hay. AI chỉ gợi ý đúng khi biết miền nghiệp vụ, kiểu dữ liệu, vòng đời và quy ước của codebase; việc đổi tên vẫn phải qua công cụ refactor và test.

Ý chính
  • Cho AI đủ ngữ cảnh: vai trò, kiểu, phạm vi của biến và vài tên có sẵn trong dự án trước khi xin gợi ý.
  • Ghi đơn vị và loại vào tên: timeout_ms thay cho timeout, user_id khác user, danh sách dùng số nhiều.
  • Đổi tên như một refactor: dùng chức năng rename của IDE, kiểm chuỗi, cấu hình, SQL rồi chạy test.

Bắt đầu từ một ví dụ cụ thể

Ví dụ xuyên suốt bài là biến data trong một hàm xử lý hóa đơn. Nếu danh sách chỉ chứa các hóa đơn đang chờ thanh toán, tên pending_invoices nói đúng nội dung; nếu nó còn chứa dữ liệu thô chưa lọc, chính tên đó lại gây hiểu sai. Vì thế AI cần biết vai trò, kiểu và nguồn gốc của biến trước khi gợi ý bất kỳ tên nào.

PROMPT ĐẶT TÊNd = 7data = load()do_it()retention_days = 7pending_invoices = load()archive_orders()VÍ DỤ KIỂM ĐƯỢCdata → pending_invoices khi danh sách chỉ chứa hóa đơn chờ
PROMPT ĐẶT TÊN d = 7 data = load() do_it() retention_days = 7 pending_invoices = load() archive_orders() VÍ DỤ KIỂM ĐƯỢC data → pending_invoices khi danh sách chỉ chứa hóa đơn chờ
Hình 1. data → pending_invoices khi danh sách chỉ chứa hóa đơn chờ.

Tên trả lời câu hỏi nào

Biến nên nói giá trị đại diện gì; hàm nên nói hành động hoặc câu hỏi nó trả lời. data, process và handle thường che ý. Tuy nhiên i trong vòng lặp nhỏ hoặc x, y trong công thức quen thuộc có thể đủ. Ngữ cảnh quyết định mức chi tiết.

Đưa miền nghiệp vụ

status có thể là trạng thái đơn, thanh toán hoặc giao hàng. Hãy cung cấp thuật ngữ chính thức của sản phẩm và từ không được dùng. AI không nên tự dịch hoặc tạo khái niệm mới. Tên code, tài liệu và giao diện cần chỉ cùng một điều.

Theo quy ước dự án

Nêu ngôn ngữ, kiểu chữ, tiền tố boolean, quy tắc bất đồng bộ và ví dụ từ module gần đó. Tên đúng về ngữ nghĩa nhưng phá convention vẫn làm code khó đọc. Yêu cầu AI ưu tiên mẫu hiện có, không áp một style chung từ bên ngoài.

Phân biệt loại và số lượng

Tên số nhiều cho collection, đơn vị cho số đo, thời điểm cho timestamp và hậu tố phù hợp cho id. timeout mơ hồ hơn timeout_ms; user khác user_id. Những chi tiết này ngăn lỗi dùng nhầm mà type checker có thể không bắt.

Đổi tên như một refactor

Dùng rename symbol của IDE khi có thể, tìm tham chiếu động, cấu hình, serialization và API công khai. AI có thể bỏ sót string, SQL hoặc template. Lập danh sách bề mặt, đổi từng nhóm và chạy test. Không đổi tên công khai chỉ để hợp sở thích.

Chấm tên bằng cách đọc câu

Đặt tên vào câu: “biến này chứa…”, “hàm này sẽ…”. Nếu phải thêm nhiều lời giải thích, tên hoặc thiết kế chưa rõ. So ba phương án theo chính xác, ngắn và nhất quán; tránh bỏ phiếu chỉ vì một tên nghe chuyên nghiệp.

Bốn prompt mẫu chép dùng ngay

Prompt 1: gợi ý tên có lý do

Trong đoạn code [ngôn ngữ], đối tượng này có vai trò [mô tả], kiểu [kiểu], phạm vi [local/public], vòng đời [mô tả]. Quy ước dự án: [ví dụ tên gần đó]. Hãy đề xuất 7 tên, mỗi tên giải thích sắc thái và trường hợp không nên dùng. Loại tên chung chung; không đổi code. [dán đoạn nhỏ].

Prompt 2: kiểm từ vựng miền nghiệp vụ

Đây là bảng thuật ngữ được duyệt: [dán glossary] và danh sách tên hiện tại: [dán]. Hãy tìm tên dùng sai khái niệm, trộn hai nghĩa hoặc khác cách gọi trong sản phẩm. Trả bảng tên cũ, vấn đề, tên đề xuất, bằng chứng từ glossary và mức rủi ro khi đổi. Không sáng tạo thuật ngữ ngoài bảng.

Prompt 3: đặt tên cho boolean và hàm

Với mỗi boolean hoặc hàm dưới đây, hãy viết câu hỏi mà nó trả lời, rồi đề xuất tên đọc tự nhiên tại nơi gọi. Phân biệt trạng thái (is/has/can/should) với hành động. Giữ đúng quy ước [ngôn ngữ/repo]. Nếu hàm làm nhiều việc nên không thể đặt tên gọn, đánh dấu cần tách nhưng chưa refactor. [dán chữ ký và call site].

Prompt 4: kế hoạch rename an toàn

Tôi muốn đổi [tên cũ] thành [tên mới]. Hãy lập danh sách nơi phải kiểm: symbol tĩnh, import, test, cấu hình, chuỗi, dữ liệu serialize, SQL, API và tài liệu. Phân loại nơi có thể rename tự động và nơi cần kiểm tay. Đưa lệnh tìm kiếm và test phù hợp; chưa sửa tệp, không đổi các tên giống chữ nhưng khác nghĩa.

Khi kết quả chưa đúng thì sửa prompt thế nào

Nếu AI cho tên quá dài, nêu phạm vi nhỏ và yêu cầu tối đa số từ. Nếu tên chung chung, bổ sung kiểu, đơn vị và vai trò. Nếu nó áp convention lạ, đưa ba ví dụ thật từ repo. Nếu đổi quá rộng, giới hạn một symbol và yêu cầu kế hoạch. Nếu các đề xuất đồng nghĩa, bắt mô tả sự khác biệt khi đọc tại call site.

Bài thực hành

Lấy một hàm có ba tên data, result, process. Viết vai trò và kiểu của từng cái, chạy Prompt 1 rồi chọn tên bằng câu đọc thử. Dùng Prompt 4 để liệt kê bề mặt đổi tên. Rename bằng IDE, chạy test và kiểm rg xem còn chuỗi cũ có ý nghĩa không.

Ca mẫu: đổi data thành tên mang nghĩa nghiệp vụ

Trong một hàm xử lý đơn, ba biến cùng tên gần giống data, result và items; người đọc không biết đó là dòng đơn, sản phẩm hay payload trả về. Trước khi rename, hãy truy theo nguồn và nơi dùng của từng biến. Nếu data là danh sách dòng đã định giá, priced_order_items nói rõ hơn; nếu nó vẫn chứa dữ liệu thô, tên đó lại sai. Đưa glossary của nhóm để AI dùng cùng một từ với giao diện và tài liệu, tránh tự dịch order line thành nhiều cách. Chỉ đổi một nhóm tên mỗi commit và dùng công cụ rename hiểu cú pháp khi có thể. Kiểm string, cấu hình, serialization và API public vì tìm-thay văn bản có thể bỏ sót hoặc sửa quá tay. Đọc câu gọi hàm sau khi đổi: archive_expired_orders(cutoff_date) truyền đạt hành động và điều kiện tốt hơn process(data). Tên dài không tự động tốt; phần ngữ cảnh đã được module hoặc kiểu dữ liệu cung cấp thì không cần lặp. Mục tiêu là giảm số giả định người bảo trì phải giữ trong đầu, không phải đạt một công thức số ký tự. Sau khi đổi, hãy mở diff và tìm mọi nơi tên cũ còn tồn tại có chủ đích. Ghi chú alias tương thích cùng ngày dự kiến xóa để nó không trở thành nợ vĩnh viễn. Với tên public, cập nhật ví dụ tài liệu và thông báo thay đổi cho người gọi trước khi phát hành.

Prompt thứ năm: tự kiểm bằng tình huống của bạn

Tôi sẽ gửi một module và glossary nghiệp vụ. Hãy lập bảng tên public và local gồm tên hiện tại, nghĩa suy ra từ hành vi, thuật ngữ chuẩn, mức mơ hồ và đề xuất. Chọn tối đa ba tên gây hiểu sai, tìm nơi dùng trong phạm vi được cung cấp và mô tả rủi ro tương thích. Với mỗi tên mới, đọc thành một câu tại nơi gọi để kiểm độ tự nhiên. Nếu thiếu ngữ cảnh miền, hãy hỏi thay vì dịch máy. Kết thúc bằng kế hoạch rename cơ học, test cần chạy và API phải giữ alias tạm thời.

Câu hỏi thường gặp

PEP 8 quy định tên hàm và biến thế nào?

Tên hàm và biến viết thường, các từ nối bằng dấu gạch dưới khi cần cho dễ đọc, ví dụ retention_days. PEP 8 cũng khuyên không dùng l, O, I làm tên biến một ký tự.

Tên dài hơn có luôn rõ hơn không?

Không. Phần ngữ cảnh mà module hay kiểu dữ liệu đã nói thì không cần lặp lại; i trong một vòng lặp ngắn vẫn đủ rõ.

Đổi tên bằng tìm và thay văn bản có an toàn không?

Không an toàn bằng chức năng rename symbol của IDE, vì tìm và thay có thể sửa nhầm chữ giống tên. Dù dùng cách nào, vẫn phải tìm tay trong chuỗi, cấu hình, SQL, dữ liệu đã serialize rồi chạy test.

Học tiếp

Muốn học bài bản cùng giảng viên?

Khóa AI – Introduction to Machine Learning: nền tảng Máy học từ thuật toán cơ bản đến Neural Networks và LLM, học bằng Python. Học thử buổi 1 miễn phí.

Xem Khóa AI

Nguồn tham khảo

Chia sẻ: Facebook LinkedIn
Nhắn Zalo tư vấnZalo Gọi 0937 401 483