Merge pull request #1836 from sharwell/fix-1830

Fix handling of tabs inside of documentation comments

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/SpacingRules/SA1027UnitTests.cs

@@ -101,13 +101,13 @@ public void Bar()
         public async Task TestInvalidTabsInDocumentationCommentsAsync()
         {
             var testCode =
-                "\t/// <summary>\r\n" +
-                "\t/// foo bar\r\n" +
-                "\t/// </summary>\r\n" +
+                "\t///\t<summary>\r\n" +
+                "\t/// foo\tbar\r\n" +
+                "\t///\t</summary>\r\n" +
                 "\tpublic class Foo\r\n" +
                 "\t{\r\n" +
-                "\t \t/// <MyElement> Value </MyElement>\r\n" +
-                "\t\t/// <MyElement> Value </MyElement>\r\n" +
+                "\t \t/// <MyElement>\tValue </MyElement>\r\n" +
+                "\t\t/**\t \t<MyElement> Value </MyElement>\t*/\r\n" +
                 "\t}\r\n";
 
             var fixedTestCode = @"    /// <summary>
@@ -116,19 +116,25 @@ public async Task TestInvalidTabsInDocumentationCommentsAsync()
     public class Foo
     {
         /// <MyElement> Value </MyElement>
-        /// <MyElement> Value </MyElement>
+        /**     <MyElement> Value </MyElement>  */
     }
 ";
 
             DiagnosticResult[] expected =
             {
                 this.CSharpDiagnostic().WithLocation(1, 1),
+                this.CSharpDiagnostic().WithLocation(1, 5),
                 this.CSharpDiagnostic().WithLocation(2, 1),
+                this.CSharpDiagnostic().WithLocation(2, 5),
                 this.CSharpDiagnostic().WithLocation(3, 1),
+                this.CSharpDiagnostic().WithLocation(3, 5),
                 this.CSharpDiagnostic().WithLocation(4, 1),
                 this.CSharpDiagnostic().WithLocation(5, 1),
                 this.CSharpDiagnostic().WithLocation(6, 1),
+                this.CSharpDiagnostic().WithLocation(6, 19),
                 this.CSharpDiagnostic().WithLocation(7, 1),
+                this.CSharpDiagnostic().WithLocation(7, 6),
+                this.CSharpDiagnostic().WithLocation(7, 39),
                 this.CSharpDiagnostic().WithLocation(8, 1),
             };
 

StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1027TabsMustNotBeUsed.cs

@@ -69,6 +69,11 @@ private static void HandleSyntaxTree(SyntaxTreeAnalysisContext context)
                     HandleWhitespaceTrivia(context, trivia);
                     break;
 
+                case SyntaxKind.SingleLineDocumentationCommentTrivia:
+                case SyntaxKind.MultiLineDocumentationCommentTrivia:
+                    HandleDocumentationCommentTrivia(context, trivia);
+                    break;
+
                 default:
                     break;
                 }
@@ -93,5 +98,34 @@ private static void HandleWhitespaceTrivia(SyntaxTreeAnalysisContext context, Sy
             // Tabs must not be used.
             context.ReportDiagnostic(Diagnostic.Create(Descriptor, trivia.GetLocation()));
         }
+
+        private static void HandleWhitespaceToken(SyntaxTreeAnalysisContext context, SyntaxToken token)
+        {
+            string fullString = token.ToFullString();
+            if (fullString.IndexOf('\t') < 0)
+            {
+                // No hard tabs were found.
+                return;
+            }
+
+            // Tabs must not be used.
+            context.ReportDiagnostic(Diagnostic.Create(Descriptor, token.GetLocation()));
+        }
+
+        private static void HandleDocumentationCommentTrivia(SyntaxTreeAnalysisContext context, SyntaxTrivia trivia)
+        {
+            foreach (var token in trivia.GetStructure().DescendantTokens(descendIntoTrivia: true))
+            {
+                switch (token.Kind())
+                {
+                case SyntaxKind.XmlTextLiteralToken:
+                    HandleWhitespaceToken(context, token);
+                    break;
+
+                default:
+                    break;
+                }
+            }
+        }
     }
 }