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?
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>
{
}
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"/>
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With