Search code examples
c#visual-studiovisual-studio-2017compiler-warningscode-documentation

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


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?


Solution

  • To reference a type parameter, use <typeparamref name="T" />.

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