UseUTF8EncodingForHelpFile

Nível de gravidade: Aviso

Descrição

Esta regra deteta quando um about_ ficheiro de ajuda não utiliza codificação UTF-8. A regra verifica se os ficheiros de ajuda que começam about_ e terminam com .help.txt estão guardados na codificação UTF-8. Utiliza a propriedade CurrentEncoding da classe StreamReader para verificar a codificação do ficheiro.

Para garantir que os seus ficheiros de ajuda utilizam a codificação correta, siga estas diretrizes:

  • Ao usar comandos PowerShell para escrever em ficheiros, defina o parâmetro de codificação para utf8, utf8BOM, ou utf8NoBOM.
  • Ao criar ou editar ficheiros de ajuda num editor de texto, configure-o para guardar ficheiros em formato UTF-8. Consulte a documentação do seu editor para instruções sobre como definir a codificação do ficheiro.

Exemplo

Não conforme

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

$helpText | Set-Content -Path "about_Contoso.help.txt" -Encoding Unicode

Compliant

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

$helpText | Set-Content -Path "about_Contoso.help.txt" -Encoding utf8NoBOM

Ver também

Para obter mais informações, consulte os seguintes artigos:

  • Last updated on