Permalink
Fetching contributors…
Cannot retrieve contributors at this time
64 lines (50 sloc) 1.4 KB

SA1004

TypeName SA1004DocumentationLinesMustBeginWithSingleSpace
CheckId SA1004
Category Spacing Rules

Cause

A line within a documentation header above a C# element does not begin with a single space.

Rule description

A violation of this rule occurs when a line within a documentation header does not begin with a single space. For example:

///<summary>
///The summary text.
///</summary>
///   <param name="x">The document root.</param>
///    <param name="y">The Xml header token.</param>
private void Method1(int x, int y)
{
}

The header lines should begin with a single space after the three leading forward slashes:

/// <summary>
/// The summary text.
/// </summary>
/// <param name="x">The document root.</param>
/// <param name="y">The Xml header token.</param>
private void Method1(int x, int y)
{
}

How to fix violations

To fix a violation of this rule, ensure that the header line begins with a single space.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1004:DocumentationLinesMustBeginWithSingleSpace", Justification = "Reviewed.")]
#pragma warning disable SA1004 // DocumentationLinesMustBeginWithSingleSpace
#pragma warning restore SA1004 // DocumentationLinesMustBeginWithSingleSpace