StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules > SA1620: GenericTypeParameterDocumentationMustMatchTypeParameters

StyleCop 4.3	Send comments on this topic.
SA1620: GenericTypeParameterDocumentationMustMatchTypeParameters

Glossary Item Box

TypeName	GenericTypeParameterDocumentationMustMatchTypeParameters
CheckId	SA1620
Category	Documentation Rules

Cause

The <typeparam> tags within the Xml header documentation for a generic C# element do not match the generic type parameters on the element.

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: http://msdn.microsoft.com/en-us/magazine/cc302121.aspx.

A violation of this rule occurs if the <typeparam> tags within the element’s header documentation do not match the generic type parameters on the element, or do not appear in the same order as the element’s type parameters.

How to Fix Violations

To fix a violation of this rule, add and fill-in one <typeparam> tag for each generic type parameter on the element, and make sure that the <typeparam> tags appear in the same order as the element’s type parameters.

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>

{

}