AvoidAssignmentToAutomaticVariable

Nível de gravidade: Aviso

Description

Esta regra deteta atribuições a variáveis automáticas e nomes de parâmetros que usam nomes automáticos de variáveis. O PowerShell define automaticamente variáveis que armazenam informação interna de estado e gere-as por si só. Embora possa sobrescrever muitas variáveis automáticas, fazê-lo pode ter efeitos inesperados para os utilizadores e tornar o seu código mais difícil de manter e depurar.

Evite usar nomes automáticos de variáveis nas suas funções e parâmetros. Reserve as variáveis automáticas apenas para uso interno do PowerShell e confie nelas apenas para ler informações de estado.

Para saber mais, consulte about_Automatic_Variables.

Como

Use nomes de variáveis em funções ou os seus parâmetros que não entrem em conflito com variáveis automáticas.

Exemplo

Não conforme

A variável $Error é uma variável automática que existe no âmbito global e, por isso, nunca deve ser usada como nome de variável ou parâmetro.

function foo($Error){ }

function Get-CustomErrorMessage($ErrorMessage){ $Error = "Error occurred: $ErrorMessage" }

Compliant

function Get-CustomErrorMessage($ErrorMessage){ $FinalErrorMessage = "Error occurred: $ErrorMessage" }