Skip to content

Add rule documentation for ProvideDefaultParameter #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 18, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions RuleDocumentation/ProvideDefaultParameterValue.md
Original file line number Diff line number Diff line change
@@ -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:

```
function Test($Param1 = $null)
{
$Param1
}
```