Đề cập đến một loại chung loại chung trong tài liệu C# XML?

Question

Viết một số tài liệu XML cho một lớp trợ giúp vị ngữ. Nhưng tôi không thể hiểu được tôi có thể tham chiếu đến một số Expression<Func<T, bool>> mà không nhận được lỗi cú pháp. Thậm chí có thể không? Tôi đã thử điều này:

<see cref="Expression{Func{T, bool}}"/> 

Nhưng tôi nhận được đường kẻ màu đỏ dưới {T, bool}}. Công việc này mặc dù:

<see cref="Expression{TDelegate}"/> 

Bất kỳ ai có đầu mối?

---

Cập nhật:

Câu trả lời đó đã được đưa ra (và tôi chấp nhận) dường như đã làm việc. Nhưng bây giờ tôi đã bắt đầu nhận được rất nhiều cảnh báo về những thứ không thể giải quyết được. Tôi có một lớp được gọi là ExpressionBuilder<T> hoạt động với số Expression<Func<T, bool>> rất nhiều. Vì vậy, tất nhiên tôi muốn đề cập đến điều đó trong các bình luận XML của tôi.

Tôi đã thử cả hai phiên bản mà tôi biết về:

<see cref="Expression&lt;Func&lt;T, Boolean&gt;&gt;"/> 
<see cref="Expression{Func{T, Boolean}}"/> 

Nhưng không phải làm việc. (Và trên người cuối cùng, ReSharper đặt một màu xanh nguệch ngoạc dưới {T,Boolean}} tôi nhận được hai cảnh báo dưới biên soạn ở khắp mọi nơi tôi đã sử dụng nó mà nói rằng:

1. XML bình luận về 'blah blah' đã cref Biểu hiện thuộc tính '> 'mà không thể được giải quyết
2. khai tham số loại phải là một định danh không phải là một kiểu. Xem thêm lỗi CS0081.

có cùng một vấn đề ở đâu đó tôi đã cố gắng để chỉ Range<Nullable<DateTime>> (Range<DateTime?> không hoạt động. Cả hai đều có {} và với < >)

Tôi không được phép tham khảo các loại thuốc generic này?

Answer 1

Dường như không có cách nào đề cập đến một chung chung của một tài liệu XML chung chung, bởi vì trên thực tế, không có cách nào để chỉ chung một loại cụ thể nào.

Lasse V Karlsen của answer đã làm cho nó nhấp cho tôi:

Nếu bạn viết <see cref="IEnumerable{Int32}" />, trình biên dịch chỉ sử dụng "Int32" như tên tham số kiểu, không phải là đối số kiểu. Viết <see cref="IEnumerable{HelloWorld}" /> cũng sẽ hoạt động. Điều này có ý nghĩa vì không có trang cụ thể trong MSDN cho "IEnumerable of int" mà tài liệu của bạn có thể liên kết đến.

Để ghi lại lớp học của bạn đúng, tôi nghĩ rằng bạn sẽ phải viết một cái gì đó như:

<summary> 
Returns an <see cref="IEnumerable{T}" /> of <see cref="KeyValuePair{T,U}" /> 
of <see cref="String" />, <see cref="Int32" />. 
</summary> 

Tôi hy vọng bạn thích văn bản.

Answer 2

// Use "&lt;" instead of "<" symbol and "&gt;" instead of ">" symbol. 

// Sample: 

<see cref="Expression&lt;Func&lt;T, bool&gt;&gt;"/> 

Answer 3

Chính xác bạn muốn liên kết tới điều gì?

Không có nội dung nào trong tài liệu dưới dạng Expression<Func<T>>, do đó, rõ ràng liên kết đến điều đó sẽ không hoạt động.

Bạn có thể liên kết đến Expression<TDelegate> vì điều đó tồn tại.

Đối với những gì làm việc hay không, không ai trong số các công việc sau trong Visual Studio 2008/NET 3.5 cho tôi:

/// <see cref="Expression&lt;Func&lt;T&gt;&gt;"/>. 
/// <see cref="Expression{Func{T}}"/>. 

Nhưng công trình này:

/// <see cref="Expression{T}"/>. 

như vậy rõ ràng các loại generic tham số không phải giống với thông số trong khai báo.

Answer 4

Tôi hiện đang chạy vào tính năng này vì tôi có chức năng trả về List<List<byte>>. Yeah, nó xấu xí, nhưng tôi không viết nó. Từ chối trách nhiệm tiêu chuẩn, tôi biết.

Dù sao, trong VS 2017 với R # Cuối cùng 2017,1, bình luận doc này ...

<returns><see cref="List{List{Byte}}" /> of split frames</returns> 

... mang lại cho tôi một lỗi cú pháp. Tuy nhiên, điều này ...

<returns><see><cref>List{List{byte}}</cref></see> of split frames</returns>

... không. Eeeenteresting.

Vẫn còn xấu xí? Vâng.

Là xấu xí? Tôi nghĩ nó ít kinh khủng hơn việc sử dụng < và > bản thân mình ....

Answer 5

Không sử dụng phần tử xem trống (<see cref="..." />). Thay vào đó, hãy đặt văn bản bên trong phần tử xem

<see cref="IEnumerable{T}">IEnumerable</see>&lt;<see cref="..."/>$gt;