Navigation:  StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules >

SA1614: ElementParameterDocumentationMustHaveText

Previous pageReturn to chapter overviewNext page
StyleCop 4.3

Send comments on this topic.

SA1614: ElementParameterDocumentationMustHaveText
Glossary Item Box
TypeName

ElementParameterDocumentationMustHaveText

CheckId

SA1614

Category

Documentation Rules

 

Cause

A <param> tag within a C# element’s documentation header is empty.

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 the documentation for an element contains a <param> tag which is empty and does not contain a description of the parameter.

How to Fix Violations

To fix a violation of this rule, fill-in a description of the parameter within the <param> tag.
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;

   }

 


© Microsoft Corporation. All Rights Reserved.