Skip to content

AvoidDefaultValueSwitchParameter.md

Latest commit

 

History

History
56 lines (44 loc) · 755 Bytes

AvoidDefaultValueSwitchParameter.md

File metadata and controls

56 lines (44 loc) · 755 Bytes
description Switch Parameters Should Not Default To True
ms.custom PSSA v1.21.0
ms.date 06/28/2023
ms.topic reference
title 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
    )
    ...
}