StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules

StyleCop 4.3	Send comments on this topic.
SA1600: ElementsMustBeDocumented

Glossary Item Box

TypeName	ElementsMustBeDocumented
CheckId	SA1600
Category	Documentation Rules

Cause

A C# code element is missing a documentation header.

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 is completely missing a documentation header, or if the header is empty. In C# the following types of elements can have documentation headers: classes, constructors, delegates, enums, events, finalizers, indexers, interfaces, methods, properties, and structs.

How to Fix Violations

To fix a violation of this rule, add or fill-in a documentation header for the element.

For example, the following example shows a method with a valid documentation header:

/// <summary>

/// Joins a first name and a last name together into a single string.

/// </summary>

/// <param name="firstName">The first name to join.</param>

/// <param name="lastName">The last name to join.</param>

/// <returns>The joined names.</returns>

public string JoinNames(string firstName, string lastName)

{

return firstName + " " + lastName;

}