TypeName | ElementParametersMustBeDocumented |
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: http://msdn.microsoft.com/en-us/magazine/cc302121.aspx.
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;
}