AvoidDefaultValueSwitchParameter.md

description	ms.custom	ms.date	ms.topic	title
Switch Parameters Should Not Default To True	PSSA v1.21.0	10/18/2021	reference	AvoidDefaultValueSwitchParameter

AvoidDefaultValueSwitchParameter

Severity Level: Warning

Description

Switch parameters for commands should default to false.

How

Change the default value of the switch parameter to be false.

Example

Wrong

function Test-Script
{
    [CmdletBinding()]
    Param
    (
        [String]
        $Param1,

        [switch]
        $Switch=$True
    )
    ...
}

Correct

function Test-Script
{
    [CmdletBinding()]
    Param
    (
        [String]
        $Param1,

        [switch]
        $Switch=$False
    )
    ...
}