Tài liệu hướng dẫn trợ giúp trong Delphi 2007

Question

Tôi đang sử dụng D2007 và đang cố gắng ghi lại mã nguồn của mình, sử dụng tính năng HelpInsight (được cung cấp kể từ D2005). Tôi chủ yếu quan tâm đến việc giúp các mẹo công cụ HelpInsight hoạt động. Từ nhiều hoạt động lướt web và thử nghiệm khác nhau, tôi đã tìm thấy những điều sau đây:

1. Sử dụng kiểu dấu ba chấm (///) hoạt động thường xuyên hơn các kiểu nhận xét được ghi nhận khác. ví dụ: {*! comment *} và {! comment }
2. Các nhận xét phải đứng trước tuyên bố mà chúng đang thực hiện. Đối với hầu hết các trường hợp, điều này có nghĩa là đặt chúng trong phần giao diện của mã. (Ngoại lệ rõ ràng là đối với các loại và chức năng không thể truy cập từ bên ngoài thiết bị hiện tại và do đó được khai báo trong khối thực hiện.)
3. Nhận xét đầu tiên không thể cho một chức năng. (tức là nó phải dành cho một loại - hoặc ít nhất nó xuất hiện trình phân tích cú pháp phải đã thấy từ khóa "loại" trước khi tính năng HelpInsight hoạt động)

Mặc dù tuân theo "quy tắc" này, đôi khi thông tin trợ giúp chỉ làm không tìm thấy những bình luận tôi đã viết. Một tệp không tạo ra các mẹo công cụ HelpInsight đúng, nhưng nếu tôi đưa tệp này vào một dự án giả khác, nó hoạt động đúng.

Có ai có bất kỳ gợi ý/thủ thuật nào khác để giúp HelpInsight hoạt động không?

Answer 1

tôi đã phát hiện ra một caveat (mà trong trường hợp của tôi là những gì là "sai")

Dường như các đơn vị với HelpInsight bình luận phải được bổ sung một cách rõ ràng cho dự án. Nó không đủ để chỉ đơn giản là có các đơn vị trong một con đường được tìm kiếm khi biên dịch dự án.

Nói cách khác, đơn vị phải được bao gồm trong tệp .dpr/.dproj của Dự án. (Sử dụng tùy chọn menu "Thêm vào Dự án" của Dự án)