Move comments to preceding line

dotnet · Oct 1, 2019 · 17bf198 · 17bf198
1 parent ed00cea
commit 17bf198
Showing 1 changed file with 11 additions and 7 deletions.
diff --git a/src/GenerateAnalyzerRulesets/Program.cs b/src/GenerateAnalyzerRulesets/Program.cs
@@ -481,9 +481,10 @@ static void endRulesSection(StringBuilder result)
                 result.AppendLine("   </Rules>");
             }
 
-            static void addRuleEntry(StringBuilder result, DiagnosticDescriptor rule, string severity, string spacingForTitle)
+            static void addRuleEntry(StringBuilder result, DiagnosticDescriptor rule, string severity)
             {
-                result.AppendLine($@"      <Rule Id=""{rule.Id}"" Action=""{severity}"" /> {spacingForTitle} <!-- {rule.Title} -->");
+                var spacing = new string(' ', count: 15 - severity.Length);
+                result.AppendLine($@"      <Rule Id=""{rule.Id}"" Action=""{severity}"" /> {spacing} <!-- {rule.Title} -->");
             }
 
             static string getSeverityString(DiagnosticSeverity? severityOpt)
@@ -546,9 +547,11 @@ static void endRulesSection(StringBuilder _)
             {
             }
 
-            static void addRuleEntry(StringBuilder result, DiagnosticDescriptor rule, string severity, string spacingForTitle)
+            static void addRuleEntry(StringBuilder result, DiagnosticDescriptor rule, string severity)
             {
-                result.AppendLine($@"dotnet_diagnostic.{rule.Id}.severity = {severity} {spacingForTitle} # {rule.Title}");
+                result.AppendLine();
+                result.AppendLine($"# {rule.Id}: {rule.Title}");
+                result.AppendLine($@"dotnet_diagnostic.{rule.Id}.severity = {severity}");
             }
 
             static string getSeverityString(DiagnosticSeverity? severityOpt)
@@ -575,7 +578,7 @@ private static string GetRulesetOrEditorconfigText(
             Action<StringBuilder> endRulesetOrEditorconfig,
             Action<StringBuilder> startRulesSection,
             Action<StringBuilder> endRulesSection,
-            Action<StringBuilder, DiagnosticDescriptor, string, string> addRuleEntry,
+            Action<StringBuilder, DiagnosticDescriptor, string> addRuleEntry,
             Func<DiagnosticSeverity?, string> getSeverityString,
             string commentStart,
             string commentEnd,
@@ -598,6 +601,8 @@ private static string GetRulesetOrEditorconfigText(
                 result.AppendLine($@"{commentStart}{categoryOpt ?? customTagOpt} Rules{commentEnd}");
                 addRules(categoryPass: categoryOpt != null, customTagPass: customTagOpt != null);
                 result.AppendLine();
+                result.AppendLine();
+                result.AppendLine();
                 result.AppendLine($@"{commentStart}Other Rules{commentEnd}");
                 addRules(categoryPass: false, customTagPass: false);
             }
@@ -632,8 +637,7 @@ void addRule(DiagnosticDescriptor rule)
                     }
 
                     string severity = getRuleAction(rule);
-                    var spacing = new string(' ', count: 15 - severity.Length);
-                    addRuleEntry(result, rule, severity, spacing);
+                    addRuleEntry(result, rule, severity);
                 }
 
                 bool shouldSkipRule(DiagnosticDescriptor rule)