Add summary comment to some rules with short description (#1087)

* Add summary comment to some rules with short description

* correct typo

* add period

* add period

Author: pedrocodacy

Rules/AlignAssignmentStatement.cs

@@ -14,7 +14,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to walk an AST to check if consecutive assignment statements are aligned.
+    /// AlignAssignmentStatement: Checks if consecutive assignment statements are aligned.
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]

Rules/AvoidAssignmentToAutomaticVariable.cs

@@ -14,7 +14,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// AvoidAssignmentToAutomaticVariable: 
+    /// AvoidAssignmentToAutomaticVariable: Checks for assignment to automatic variables.
     /// </summary>
 #if !CORECLR
 [Export(typeof(IScriptRule))]

Rules/AvoidGlobalAliases.cs

@@ -13,6 +13,9 @@
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
+    /// <summary>
+    /// AvoidGlobalAliases: Checks that global aliases are not used.
+    /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif

Rules/AvoidGlobalFunctions.cs

@@ -12,6 +12,9 @@
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
+    /// <summary>
+    /// AvoidGlobalFunctions: Checks that global functions are not used within modules.
+    /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif

Rules/AvoidTrailingWhitespace.cs

@@ -14,7 +14,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to walk an AST to check for violation.
+    /// AvoidTrailingWhitespace: Checks for trailing whitespaces
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]

Rules/PlaceCloseBrace.cs

@@ -14,7 +14,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to walk an AST to check for violation.
+    /// PlaceCloseBrace: Indicates if there should or should not be an empty line before a close brace.
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]

Rules/UseCompatibleCmdlets.cs

@@ -18,11 +18,14 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to check if a script uses Cmdlets compatible with a given version and edition of PowerShell.
+    /// UseCompatibleCmdlets: Checks if a script uses Cmdlets compatible with a given version and edition of PowerShell.
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
+    /// <summary>
+    /// A class to check if a script uses Cmdlets compatible with a given version and edition of PowerShell.
+    /// </summary>
     public class UseCompatibleCmdlets : AstVisitor, IScriptRule
     {
         private struct RuleParameters

Rules/UseConsistentIndentation.cs

@@ -14,7 +14,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to walk an AST to check for violation.
+    /// UseConsistentIndentation: Checks if indentation is consistent throughout the source file.
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]

Rules/UseConsistentWhitespace.cs

@@ -15,7 +15,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to walk an AST to check for [violation]
+    /// UseConsistentWhitespace: Checks if whitespace usage is consistent throughout the source file.
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]

Rules/UseLiteralInitializerForHashtable.cs

@@ -15,7 +15,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to walk an AST to check if hashtable is not initialized using [hashtable]::new or new-object hashtable
+    /// UseLiteralInitializerForHashtable: Checks if hashtable is not initialized using [hashtable]::new or new-object hashtable.
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]

Rules/UseSupportsShouldProcess.cs

@@ -15,7 +15,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// A class to that implements the UseSupportsShouldProcess rule.
+    /// UseSupportsShouldProcess: Checks if a function defines Confirm and/or WhatIf parameters manually instead of using SupportsShouldProcess attribute.
     /// </summary>
 #if !CORECLR
     [Export(typeof(IScriptRule))]