Làm thế nào để liên kết/nhóm quá tải trong C# XML ý kiến?

Question

Trong tài liệu XML ý kiến ​​nhận xét cho C#, có cách nào để đánh dấu hai hoặc nhiều hàm trở thành quá tải của nhau, sao cho chúng tự động tham chiếu với nhau? Lý tưởng nhất, họ cũng sẽ được nhóm lại trong tài liệu tạo ra từ lâu đài cát bằng cách nào đó.

Mục đích: Thông thường, tôi muốn liên kết với nhóm chức năng này, ví dụ: trong danh sách các chức năng tiện ích, chỉ đề cập đến một trong những tình trạng quá tải và làm cho những người khác dễ dàng khám phá từ đó.

Hiện tại tôi đang thêm liên kết nhưng điều đó thật tẻ nhạt.

Answer 1

Mối quan hệ giữa nhiều lần quá tải đã được xác định và nhóm theo tài liệu XMl và Sandcastle.

Tạo liên kết đến các thành viên khác bằng cách sử dụng các thẻ see hoặc seealso.

Ví dụ:

///See <see cref="M:AnotherMethod(System.String)"> 

Tôi đã nhận thấy rằng độ phân giải thành viên của Sandcastle có thể hơi lúng túng nên tôi có xu hướng sử dụng tên đầy đủ.

///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)"> 

Lưu ý M: cho biết thành viên đang được tham chiếu, bạn cũng sử dụng E: để trỏ đến Sự kiện. T: được sử dụng cho loại nhưng được giả định nếu không có.

Answer 2

Nhóm được thực hiện tự động bởi Sandcastle, phải, nhưng nếu bạn muốn cung cấp cho nhóm quá tải một mô tả chung, sử dụng < quá tải > thẻ cho điều này (trong cùng một cách như < tóm tắt >). Đây không phải là thẻ tài liệu XML chuẩn nhưng AFAIR được hỗ trợ bởi Trình tạo tệp trợ giúp Sandcastle.