TypeName | GenericTypeParameterDocumentationMustHaveText |
CheckId | SA1622 |
Category | Documentation Rules |
Cause
A <typeparam> tag within the Xml header documentation for a generic C# element is empty.
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 element contains an empty <typeparam> tag within its Xml header documentation.
How to Fix Violations
To fix a violation of this rule, fill-in each <typeparam> tag within a description of the generic type parameter.
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>
{
}