TypeName | DocumentationTextMustNotBeEmpty |
CheckId | SA1627 |
Category | Documentation Rules |
Cause
The Xml header documentation for a C# code element contains an empty tag.
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 when the documentation header for an element contains an empty tag. For example:
/// <summary>
/// Joins a first name and a last name together into a single string.
/// </summary>
/// <param name="firstName"> </param>
/// <param name="lastName">Part of the name.</param>
/// <returns>The joined names.</returns>
public string JoinNames(string firstName, string lastName)
{
...
}
How to Fix Violations
To fix a violation of this rule, add documentation text within the empty tag.