Permalink
Fetching contributors…
Cannot retrieve contributors at this time
57 lines (43 sloc) 1.84 KB

SA1611

TypeName SA1611ElementParametersMustBeDocumented
CheckId SA1611
Category Documentation Rules

Cause

A C# method, constructor, delegate or indexer element is missing documentation for one or more of its parameters.

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: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments.

A violation of this rule occurs if an element containing parameters is missing documentation for one or more of its parameters.

How to fix violations

To fix a violation of this rule, add or fill-in documentation text within a <param> tag for each parameter within the element.

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;
}

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1611:ElementParametersMustBeDocumented", Justification = "Reviewed.")]
#pragma warning disable SA1611 // ElementParametersMustBeDocumented
#pragma warning restore SA1611 // ElementParametersMustBeDocumented