StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules > SA1617: VoidReturnValueMustNotBeDocumented

StyleCop 4.3	Send comments on this topic.
SA1617: VoidReturnValueMustNotBeDocumented

Glossary Item Box

TypeName	VoidReturnValueMustNotBeDocumented
CheckId	SA1617
Category	Documentation Rules

Cause

A C# code element does not contain a return value, or returns void, but the documentation header for the element contains a <returns> 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 if an element which returns void contains a <returns> tag within its documentation header.

How to Fix Violations

To fix a violation of this rule, remove the <returns> tag from the element.

The following example shows a method with a valid documentation header:

/// <summary>

/// Prints the given name.

/// </summary>

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

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

public void PrintNames(string firstName, string lastName)

{

Console.WriteLine(firstName + " " + lastName);

}