TypeName | DocumentationTextMustContainWhitespace |
CheckId | SA1630 |
Category | Documentation Rules |
Cause
A section of the Xml header documentation for a C# element does not contain any whitespace between words.
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 when part of the documentation does contain any whitespace between words. This can indicate poorly written or poorly formatted documentation. For example:
/// <summary>
/// Joinsnames
/// </summary>
/// <param name="firstName">First</param>
/// <param name="lastName">Last</param>
/// <returns>Name</returns>
public string JoinNames(string firstName, string lastName)
{
...
}
How to Fix Violations
To fix a violation of this rule, ensure that all sections of the documentation contain at least one instance of whitespace between words.