SA1005

<title>SA1005: SingleLineCommentsMustBeginWithSingleSpace</title> <script src="script/helpstudio.js" type="text/jscript"></script> <script src="script/StandardText.js" type="text/jscript"></script>

</head>

<script type="text/jscript">WritePageTop(document.title);</script>

TypeName	SingleLineCommentsMustBeginWithSingleSpace
CheckId	SA1005
Category	Spacing Rules

Cause

A single-line comment within a C# code file does not begin with a single space.

Rule Description

A violation of this rule occurs when a single-line comment does not begin with a single space. For example:

private void Method1()

{

//A single-line comment.

// A single-line comment.

}

The comments should begin with a single space after the leading forward slashes:

private void Method1()

{

// A single-line comment.

// A single-line comment.

}

An exception to this rule occurs when the comment is being used to comment out a line of code. In this case, the space can be omitted if the comment begins with four forward slashes to indicate out-commented code. For example:

private void Method1()

{

////int x = 2;

////return x;

}

How to Fix Violations

To fix a violation of this rule, ensure that the comment begins with a single space. If the comment is being used to comment out a line of code, ensure that the comment begins with four forward slashes, in which case the leading space can be omitted.

How to Suppress Violations

[SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1005:SingleLineCommentsMustBeginWithSingleSpace", Justification = "Reviewed.")]