|
|
Send comments on this topic.
|
SA1604: ElementDocumentationMustHaveSummary
|
Glossary Item Box
|
|
ElementDocumentationMustHaveSummary
|
CheckId
|
SA1604
|
Category
|
Documentation Rules
|
Cause
The Xml header documentation for a C# element is missing a <summary> 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 element documentation is missing a <summary> tag.
How to Fix Violations
To fix a violation of this rule, add and fill-in a <summary> tag for the element, containing a description of the element.
The following example shows a class containing invalid Xml within its documentation header. The closing tag for the <summary> node is invalid.
/// <summary>
/// Represents a customer in the database.
/// </summary>
public class Customer
{
}
© Microsoft Corporation. All Rights Reserved.
