UseUTF8EncodingForHelpFile

Nível de gravidade: aviso

Descrição

Essa regra detecta quando um about_ arquivo de ajuda não usa codificação UTF-8. A regra verifica se os arquivos de ajuda começando e about_ terminando com .help.txt estão salvos na codificação UTF-8. Ele usa a propriedade CurrentEncoding da classe StreamReader para verificar a codificação do arquivo.

Para garantir que seus arquivos de ajuda usem a codificação correta, siga estas diretrizes:

  • Ao usar comandos PowerShell para gravar em arquivos, defina o parâmetro de codificação para utf8, utf8BOM, ou utf8NoBOM.
  • Ao criar ou editar arquivos de ajuda em um editor de texto, configure-o para salvar arquivos no formato UTF-8. Consulte a documentação do seu editor para instruções sobre como configurar a codificação do arquivo.

Example

Não Conforme

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Em conformidade

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Consulte também

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

  • Last updated on