什么是编译器警告 CS1723 "XML comment has cref attribute 'T' that refers to a type parameter"？

Question

鉴于此代码：

/// <summary>
/// Implementations represent a configuration with a specific data 
/// type <see cref="T"/> that can be used by this application.
/// </summary>
internal interface IConfiguration<T>
{
}

我在 see cref XML 元素内的 T 上收到编译器警告 CS1723：

XML comment has cref attribute 'T' that refers to a type parameter

MS Docs 在这种情况下完全没用。我为什么要关心这个警告？这是什么原因？

Answer 1

您应该在这种情况下使用 <typeparamref name="T" />。

https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/typeparamref

Answer 2

see cref（交叉引用）旨在指向实际类型（例如，作为生成文档中的超链接）。类型参数在这里没有任何意义，因为事先不知道将使用什么类型。

要记录类型参数，请使用

<typeparamref name="name"/>