Merge pull request #2052 from vweijsters/fix-2041

SA1513 will now allow a closing brace to be followed by a four slash …

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1513UnitTests.cs

@@ -796,6 +796,36 @@ var x in
             await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies that code commented out with four slashes is accepted.
+        /// This is a regression test for #2041
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestFourSlashCommentsAsync()
+        {
+            var testCode = @"
+public class TestClass
+{
+    public int Do(int i)
+    {
+        if (i > 2)
+        {
+            return 1;
+        }
+        //// else if (i == 2)
+        //// {
+        ////     return 2;
+        //// }
+
+        return 0;
+    }
+}
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
         /// <inheritdoc/>
         protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
         {

StyleCop.Analyzers/StyleCop.Analyzers/LayoutRules/SA1513ClosingBraceMustBeFollowedByBlankLine.cs

@@ -126,6 +126,27 @@ private static bool HasLeadingBlankLine(SyntaxTriviaList triviaList)
                 return false;
             }
 
+            private static bool StartsWithSpecialComment(SyntaxTriviaList triviaList)
+            {
+                foreach (var trivia in triviaList)
+                {
+                    switch (trivia.Kind())
+                    {
+                    case SyntaxKind.WhitespaceTrivia:
+                        // ignore
+                        break;
+
+                    case SyntaxKind.SingleLineCommentTrivia:
+                        return trivia.ToFullString().StartsWith("////", StringComparison.Ordinal);
+
+                    default:
+                        return false;
+                    }
+                }
+
+                return false;
+            }
+
             private static bool StartsWithDirectiveTrivia(SyntaxTriviaList triviaList)
             {
                 foreach (var trivia in triviaList)
@@ -166,9 +187,10 @@ private void AnalyzeCloseBrace(SyntaxToken token)
             {
                 var nextToken = token.GetNextToken(true, true);
 
-                if (nextToken.HasLeadingTrivia && HasLeadingBlankLine(nextToken.LeadingTrivia))
+                if (nextToken.HasLeadingTrivia
+                    && (HasLeadingBlankLine(nextToken.LeadingTrivia) || StartsWithSpecialComment(nextToken.LeadingTrivia)))
                 {
-                    // the close brace has a trailing blank line
+                    // the close brace has a trailing blank line or is followed by a single line comment that starts with 4 slashes.
                     return;
                 }