De-"Foo"ied test code, changed name from emptyElement to element, changed to use casts instead of as statements, wrapped parameter for string format in single quotes.

Author: peteri

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1627UnitTests.cs

@@ -38,50 +38,50 @@ public async Task TestMemberWithBlankElementAsync(string element)
         {
             var testCode = @"
 /// <summary>
-/// Foo
+/// Class name.
 /// </summary>
 public class ClassName
 {
     /// <summary>
-    /// Foo
+    /// Join together two strings.
     /// </summary>
-    ///<param name=""foo"">Test</param>
-    ///<param name=""bar"">Test</param>
+    ///<param name=""first"">First string.</param>
+    ///<param name=""second"">Second string.</param>
     /// <$$>  </$$>
-    public ClassName Method(string foo, string bar) { return null; }
+    public string JoinStrings(string first, string second) { return first + second; }
 }";
             var expectedDiagnostic = this.CSharpDiagnostic().WithLocation(12, 9).WithArguments(element);
             await this.VerifyCSharpDiagnosticAsync(testCode.Replace("$$", element), expectedDiagnostic, CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
-        /// Checks an element with a blank value gives an error.
+        /// Checks an element with a multiple blank values give multiple errors.
         /// </summary>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]
         public async Task TestMemberWithMultipleBlankElementsAsync()
         {
             var testCode = @"
 /// <summary>
-/// Foo
+/// Class name.
 /// </summary>
 public class ClassName
 {
     /// <summary>
-    /// Foo
+    /// Join together two strings.
     /// </summary>
-    ///<param name=""foo"">Test</param>
-    ///<param name=""bar"">Test</param>
-    /// <remarks>Foo bar</remarks>
+    ///<param name=""first"">First string.</param>
+    ///<param name=""second"">Second string.</param>
+    /// <remarks>Single line remark.</remarks>
     /// <example></example>
     /// <exception>
     ///
     /// </exception>
     /// <permission>
-    /// Multi line notes
-    /// Multi line notes
+    /// Multi line notes.
+    /// Multi line notes.
     /// </permission>
-    public ClassName Method(string foo, string bar) { return null; }
+    public string JoinStrings(string first, string second) { return first + second; }
 }";
             var expectedDiagnostics = new[]
             {
@@ -102,17 +102,17 @@ public async Task TestMemberWithEmptyElementAsync(string element)
         {
             var testCode = @"
 /// <summary>
-/// Foo
+/// Class name.
 /// </summary>
 public class ClassName
 {
     /// <summary>
-    /// Foo
+    /// Join together two strings.
     /// </summary>
-    ///<param name=""foo"">Test</param>
-    ///<param name=""bar"">Test</param>
+    ///<param name=""first"">First string.</param>
+    ///<param name=""second"">Second string.</param>
     /// <$$ />
-    public ClassName Method(string foo, string bar) { return null; }
+    public string JoinStrings(string first, string second) { return first + second; }
 }";
             var expectedDiagnostic = this.CSharpDiagnostic().WithLocation(12, 9).WithArguments(element);
             await this.VerifyCSharpDiagnosticAsync(testCode.Replace("$$", element), expectedDiagnostic, CancellationToken.None).ConfigureAwait(false);
@@ -129,17 +129,17 @@ public async Task TestMemberWithValidElementAsync(string element)
         {
             var testCode = @"
 /// <summary>
-/// Foo
+/// Class name.
 /// </summary>
 public class ClassName
 {
     /// <summary>
-    /// Foo
+    /// Join together two strings.
     /// </summary>
-    ///<param name=""foo"">Test</param>
-    ///<param name=""bar"">Test</param>
-    /// <$$>FooBar</$$>
-    public ClassName Method(string foo, string bar) { return null; }
+    ///<param name=""first"">First string.</param>
+    ///<param name=""second"">Second string.</param>
+    /// <$$>Not blank element.</$$>
+    public string JoinStrings(string first, string second) { return first + second; }
 }";
             await this.VerifyCSharpDiagnosticAsync(testCode.Replace("$$", element), EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1627DocumentationTextMustNotBeEmpty.cs

@@ -47,7 +47,7 @@ internal class SA1627DocumentationTextMustNotBeEmpty : DiagnosticAnalyzer
         /// </summary>
         public const string DiagnosticId = "SA1627";
         private const string Title = "Documentation text must not be empty";
-        private const string MessageFormat = "The documentation text within the {0} tag must not be empty.";
+        private const string MessageFormat = "The documentation text within the \'{0}\' tag must not be empty.";
         private const string Description = "The XML header documentation for a C# code element contains an empty tag.";
         private const string HelpLink = "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1627.md";
 
@@ -80,23 +80,23 @@ private static void HandleCompilationStart(CompilationStartAnalysisContext conte
 
         private static void HandleXmlElement(SyntaxNodeAnalysisContext context)
         {
-            XmlElementSyntax emptyElement = context.Node as XmlElementSyntax;
+            var element = (XmlElementSyntax)context.Node;
 
-            var name = emptyElement?.StartTag?.Name;
+            var name = element.StartTag?.Name;
 
-            if (elementsToCheck.Contains(name.ToString()) && XmlCommentHelper.IsConsideredEmpty(emptyElement))
+            if (elementsToCheck.Contains(name.ToString()) && XmlCommentHelper.IsConsideredEmpty(element))
             {
-                context.ReportDiagnostic(Diagnostic.Create(Descriptor, emptyElement.GetLocation(), name.ToString()));
+                context.ReportDiagnostic(Diagnostic.Create(Descriptor, element.GetLocation(), name.ToString()));
             }
         }
 
         private static void HandleXmlEmptyElement(SyntaxNodeAnalysisContext context)
         {
-            XmlEmptyElementSyntax emptyElement = context.Node as XmlEmptyElementSyntax;
+            var element = (XmlEmptyElementSyntax)context.Node;
 
-            if (elementsToCheck.Contains(emptyElement?.Name.ToString()))
+            if (elementsToCheck.Contains(element.Name.ToString()))
             {
-                context.ReportDiagnostic(Diagnostic.Create(Descriptor, emptyElement.GetLocation(), emptyElement?.Name.ToString()));
+                context.ReportDiagnostic(Diagnostic.Create(Descriptor, element.GetLocation(), element.Name.ToString()));
             }
         }
     }