| TypeName | SA1629DocumentationTextMustEndWithAPeriod |
| CheckId | SA1629 |
| Category | Documentation Rules |
A section of the Xml header documentation for a C# element does not end with a period (also known as a full stop).
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 when part of the documentation does not end with a period. For example, the summary text in the documentation below does not end with a period:
/// <summary>
/// Joins a first name and a last name together into a single string
/// </summary>
/// <param name="firstName">The first name.</param>
/// <param name="lastName">The last name.</param>
/// <returns>The joined names.</returns>
public string JoinNames(string firstName, string lastName)
{
...
}To fix a violation of this rule, ensure that all sections of the documentation end with a period.
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1629:DocumentationTextMustEndWithAPeriod", Justification = "Reviewed.")]#pragma warning disable SA1629 // DocumentationTextMustEndWithAPeriod
#pragma warning restore SA1629 // DocumentationTextMustEndWithAPeriod