Cách sử dụng nhận xét nội tuyến cho các thành viên tài liệu trong .NET?

Question

Tôi làm cách nào để ghi lại thành viên nội tuyến trong .Net? Hãy để tôi giải thích. Hầu hết các công cụ trích xuất tài liệu từ các nhận xét đều hỗ trợ một số loại tài liệu nội tuyến, nơi bạn có thể thêm tóm tắt sau khi khai báo thành viên. Một cái gì đó như:

public static string MyField; /// <summary>Information about MyField.</summary> 

Có cách nào để thực hiện điều này bằng ngôn ngữ C# hoặc .NET không?

Answer 1

Không, bạn không thể. Nhận xét XML chỉ được hỗ trợ dưới dạng nhận xét cấp độ khối, nghĩa là nó phải được đặt trước phần tử mã mà bạn đang tạo tài liệu. Các công cụ phổ biến để trích xuất các nhận xét XML từ mã .NET không hiểu cách phân tích các nhận xét nội tuyến như thế. Nếu bạn cần khả năng này, bạn sẽ cần phải viết trình phân tích cú pháp của riêng bạn.

Answer 2

Yep, chỉ cần đặt nó TRƯỚC điều bạn muốn bình luận

/// <summary>Information about MyField.</summary> 
public static string MyField; 

Answer 3

Không có cách tích hợp để thực hiện việc này. Hệ thống tài liệu XML là phân cấp; nó xác định mối quan hệ giữa thẻ <summary /> và dữ liệu ngay sau đó.