StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules > SA1618: GenericTypeParametersMustBeDocumented

StyleCop 4.3	Send comments on this topic.
SA1618: GenericTypeParametersMustBeDocumented

Glossary Item Box

TypeName	GenericTypeParametersMustBeDocumented
CheckId	SA1618
Category	Documentation Rules

Cause

A generic C# element is missing documentation for one or more of its generic type parameters.

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 an element containing generic type parameters is missing documentation for one or more of its generic type parameters.

How to Fix Violations

To fix a violation of this rule, add or fill-in documentation text within a <typeparam> tag for each generic type parameter on the element.

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>

{

}