What is compiler warning CS1723 "XML comment has cref attribute 'T' that refers to a type parameter" all about?

user_2704659 0
Viewed 1903

Given this code:

/// <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>
{
}

I'm getting a compiler warning CS1723 on T inside the see cref XML element:

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

MS Docs is completely useless in this case. Why should I care about this warning? What is the reason for it?

visual-studio-2017 code-documentation compiler-warnings visual-studio c#
2 Answers
user_6348240

see cref (cross reference) is meant to point to an actual type (eg as a hyperlink in the generated docs). A type parameter doesn't make any sense in this place since it is not known beforehand what type is going to be used.

To document type parameters use

<typeparamref name="name"/>

user_14472960
Related