From d6bde9dcabb1c06bed8154736f81162889416b03 Mon Sep 17 00:00:00 2001 From: Yuting Chen Date: Mon, 18 May 2015 10:02:57 -0700 Subject: [PATCH 1/2] Add rule documentation for ProvideDefaultParameter --- .../ProvideDefaultParameterValue.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 RuleDocumentation/ProvideDefaultParameterValue.md diff --git a/RuleDocumentation/ProvideDefaultParameterValue.md b/RuleDocumentation/ProvideDefaultParameterValue.md new file mode 100644 index 000000000..d88db18cb --- /dev/null +++ b/RuleDocumentation/ProvideDefaultParameterValue.md @@ -0,0 +1,30 @@ +#ProvideDefaultParameterValue +**Severity Level: Warning** + + +##Description +Parameters must have a default value as uninitialized parameters will lead to potential bugs in the scripts. + +##How to Fix + +To fix a violation of this rule, please specify a default value for all parameters + +##Example + +Wrong: + +``` +function Test($Param1) +{ + $Param1 +} +``` + +Correct: + +``` +ffunction Test($Param1 = $null) +{ + $Param1 +} +``` From 8e1b187de271cb9cc79eb6b371d189dca5135e9e Mon Sep 17 00:00:00 2001 From: "Yuting Chen[MSFT]" Date: Mon, 18 May 2015 10:05:32 -0700 Subject: [PATCH 2/2] Update ProvideDefaultParameterValue.md --- RuleDocumentation/ProvideDefaultParameterValue.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RuleDocumentation/ProvideDefaultParameterValue.md b/RuleDocumentation/ProvideDefaultParameterValue.md index d88db18cb..5569e266e 100644 --- a/RuleDocumentation/ProvideDefaultParameterValue.md +++ b/RuleDocumentation/ProvideDefaultParameterValue.md @@ -7,7 +7,7 @@ Parameters must have a default value as uninitialized parameters will lead to po ##How to Fix -To fix a violation of this rule, please specify a default value for all parameters +To fix a violation of this rule, please specify a default value for all parameters. ##Example @@ -23,7 +23,7 @@ function Test($Param1) Correct: ``` -ffunction Test($Param1 = $null) +function Test($Param1 = $null) { $Param1 }