Merge pull request #7 from yutingc/master

Add rule documentations for several rules

Author: yutingc

RuleDocumentation/AvoidAlias.md

@@ -0,0 +1,17 @@
+#AvoidAlias 
+**Severity Level: Warning**
+
+
+##Description
+
+An alias is an alternate name or nickname for a cmdlet or for a command element, such as a function, script, file, or executable file. But when writing scripts that will potentially need to be maintained over time, either by the original author or another Windows PowerShell scripter, please consider using full cmdlet name instead of alias. Aliases can introduce these problems, readability, understandability and availability.
+
+##How to Fix
+
+Please consider using full cmdlet name instead of alias. 
+
+##Example
+
+Wrong： gps | where-object {$_.WorkingSet -gt 20000000}
+
+Correct: get-process | where-object {$_.WorkingSet -gt 20000000}

RuleDocumentation/AvoidDefaultTrueValueSwitchParameter.md

@@ -0,0 +1,32 @@
+#AvoidDefaultTrueValueSwitchParameter 
+**Severity Level: Warning**
+
+
+##Description
+
+Switch Parameters Should Not Default To True
+
+
+##How to Fix
+
+Please change the default value of the switch parameter to be false.
+
+##Example
+
+Wrong：    
+
+    Param
+    (      …
+        $Param1,
+        [switch]
+        $switch=$true
+    )
+
+Correct:    
+
+    Param
+    (      …
+        $Param1,
+        [switch]
+        $switch=$false
+    )

RuleDocumentation/AvoidEmptyCatchBlock.md

@@ -0,0 +1,32 @@
+#AvoidEmptyCatchBlock 
+**Severity Level: Warning**
+
+##Description
+
+Empty catch blocks are considered poor design decisions because if an error occurs in the try block, this error is simply swallowed and not acted upon. While this does not inherently lead to bad things. It can and this should be avoided if possible. 
+
+##How to Fix
+
+To fix a violation of this rule, using Write-Error or throw statements in catch blocks.
+
+##Example
+Wrong:
+
+	try
+	{
+	    1/0
+	}
+	catch [DivideByZeroException]
+	{
+	}
+
+Correct:
+
+	try
+	{
+	    1/0
+	}
+	catch [DivideByZeroException]
+	{
+		Write-Error "DivideByZeroException"
+	}

RuleDocumentation/AvoidGlobalVars.md

@@ -0,0 +1,27 @@
+#AvoidGlobalVars 
+**Severity Level: Warning**
+
+##Description
+
+A variable is a unit of memory in which values are stored. Windows PowerShell controls access to variables, functions, aliases, and drives through a mechanism known as scoping. Variables and functions that are present when Windows PowerShell starts have been created in the global scope. This includes automatic variables and preference variables. This also includes the variables, aliases, and functions that are in your Windows PowerShell profiles.A variable is a unit of memory in which values are stored. Windows PowerShell controls access to variables, functions, aliases, and drives through a mechanism known as scoping. Variables and functions that are present when Windows PowerShell starts have been created in the global scope. This includes automatic variables and preference variables. This also includes the variables, aliases, and functions that are in your Windows PowerShell profiles.
+
+##How to Fix
+
+To fix a violation of this rule, please consider to use other scope modifiers.
+
+##Example
+Wrong:
+
+	$Global:var1 = $null
+	function NotGlobal ($var)
+	{
+    	$a = $var + $var1
+	}
+
+Correct:
+
+	$Global:var1 = $null
+	function NotGlobal ($var1,$var2)
+	{
+    	$a = $var1 + $var2
+	}

RuleDocumentation/AvoidInvokingEmptyMembers.md

@@ -0,0 +1,22 @@
+#AvoidInvokingEmptyMembers
+**Severity Level: Warning**
+
+
+##Description
+
+Invoking non-constant members would cause potential bugs. Please double check the syntax to make sure members invoked are non-constant.
+
+
+##How to Fix
+
+To fix a violation of this rule, please provide requested members for given types or classes.
+
+##Example
+
+Wrong：    
+
+    "abc".('len'+'gth')
+
+Correct:    
+
+    "abc".('length')

RuleDocumentation/AvoidReservedCharInCmdlet.md

@@ -0,0 +1,25 @@
+#AvoidReservedCharInCmdlet
+**Severity Level: Error**
+
+
+##Description
+
+You cannot use following reserved characters in a function name. These characters usually cause a parsing error. Otherwise they will generally cause runtime errors.
+'#,(){}[]&/\\$^;:\"'<>|?@`*%+=~'
+
+
+##How to Fix
+
+To fix a violation of this rule, please remove reserved characters from your advanced function name.
+
+##Example
+
+Wrong： 
+
+function test[1]
+{...}
+
+Correct:
+
+function test
+{...}

RuleDocumentation/AvoidReservedParams.md

@@ -0,0 +1,31 @@
+#AvoidReservedParams
+**Severity Level: Error**
+
+
+##Description
+
+You cannot use reserved common parameters in an advanced function. If these parameters are defined by the user, an error generally occurs.
+
+##How to Fix
+
+To fix a violation of this rule, please change the name of your parameter.
+
+##Example
+
+Wrong： 
+
+function test
+{
+
+	[CmdletBinding]
+	Param($ErrorVariable, $b)
+}
+
+Correct:
+
+function test
+{
+
+	[CmdletBinding]
+	Param($err, $b)
+}

RuleDocumentation/AvoidUsingPositionalParameters

@@ -0,0 +1,19 @@
+#AvoidUsingPositionalParameters 
+**Severity Level: Info**
+
+##Description
+
+To fix a violation of this rule, please use named parameters instead of positional parameters when calling a command.
+
+##How to Fix
+
+To fix a violation of this rule, please use named parameters instead of positional parameters when calling a command.
+
+##Example
+Wrong:
+
+	Get-ChildItem *.txt
+
+Correct:
+
+	Get-Content -Path *.txt