Merge pull request #2068 from vweijsters/fix-2056

Fixed ArgumentOutOfRangeException in SA1120

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/ReadabilityRules/SA1120UnitTests.cs

@@ -404,6 +404,35 @@ public async Task VerifyThatEmptyCommentAtFileEndWillBeHandledProperlyAsync()
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies that an unclosed multi-line comment at the end of a source file will be handled correctly.
+        /// This is a regression test for #2056
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task VerifyThatUnclosedCommentAtFileEndWillBeHandledProperlyAsync()
+        {
+            var testCode = @"public class TestClass
+{
+}
+/*";
+
+            var fixedTestCode = @"public class TestClass
+{
+}
+";
+
+            DiagnosticResult[] expected =
+            {
+                this.CSharpCompilerError("CS1035").WithMessage("End-of-file found, '*/' expected").WithLocation(4, 1),
+                this.CSharpDiagnostic().WithLocation(4, 1),
+            };
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpDiagnosticAsync(fixedTestCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
+        }
+
         protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
         {
             yield return new SA1120CommentsMustContainText();

StyleCop.Analyzers/StyleCop.Analyzers/ReadabilityRules/SA1120CommentsMustContainText.cs

@@ -71,7 +71,7 @@ private static void HandleMultiLineComment(SyntaxTreeAnalysisContext context, Sy
             var nodeText = multiLineComment.ToString();
 
             // We remove the /* and the */ and determine if the comment has any content.
-            var commentText = nodeText.Substring(2, nodeText.Length - 4);
+            var commentText = nodeText.Substring(2, Math.Max(0, nodeText.Length - 4));
 
             if (string.IsNullOrWhiteSpace(commentText))
             {