SA1621.md

SA1621

TypeName	SA1621GenericTypeParameterDocumentationMustDeclareParameterName
CheckId	SA1621
Category	Documentation Rules

Cause

A <typeparam> tag within the Xml header documentation for a generic C# element is missing a name attribute, or contains an empty name attribute.

Rule description

C# syntax provides a mechanism for inserting documentation for classes and elements directly into the code, through the use of Xml documentation headers. For an introduction to these headers and a description of the header syntax, see the following article: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments.

A violation of this rule occurs if the element contains a <typeparam> tag within its Xml header documentation which does not declare the name of the type parameter.

How to fix violations

To fix a violation of this rule, add or fill-in the name attribute for each <typeparam> tag, indicating the name of the type parameter that the documentation is for.

The following example shows a method with a valid documentation header:

/// <summary>
/// A sample generic class.
/// </summary>
/// <typeparam name="S">The first generic type parameter.</typeparam>
/// <typeparam name="T">The second generic type parameter.</typeparam>
public class Class1<S, T>
{ 
}

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1621:GenericTypeParameterDocumentationMustDeclareParameterName", Justification = "Reviewed.")]

#pragma warning disable SA1621 // GenericTypeParameterDocumentationMustDeclareParameterName
#pragma warning restore SA1621 // GenericTypeParameterDocumentationMustDeclareParameterName