Skip to content

AvoidUsingDoubleQuotesForConstantString.md

Latest commit

 

History

History
37 lines (27 loc) · 1.06 KB

AvoidUsingDoubleQuotesForConstantString.md

File metadata and controls

37 lines (27 loc) · 1.06 KB
description Avoid using double quotes if the string is constant.
ms.custom PSSA v1.21.0
ms.date 06/28/2023
ms.topic reference
title AvoidUsingDoubleQuotesForConstantString

AvoidUsingDoubleQuotesForConstantString

Severity Level: Information

Description

Single quotes should be used when the value of a string is constant. A constant string doesn't contain variables or expressions intended to insert values into the string, such as "$PID-$(hostname)").

This makes the intent clearer that the string is a constant and makes it easier to use some special characters such as $ within that string expression without needing to escape them.

There are exceptions to that when double quoted strings are more readable. For example, when the string value itself must contain a single quote or other special characters, such as newline ("`n"), are already being escaped. The rule does not warn in these cases.

Example

Wrong

$constantValue = "I Love PowerShell"

Correct

$constantValue = 'I Love PowerShell'