UseUTF8EncodingForHelpFile

úroveň závažnosti : Upozornění

Popis

Toto pravidlo detekuje, když about_ nápověda nepoužívá kódování UTF-8. Pravidlo ověřuje, že soubory nápovědy začínající na a about_ končící na .help.txt jsou uloženy v kódování UTF-8. Používá vlastnost CurrentEncoding třídy StreamReader ke kontrole kódování souboru.

Abyste zajistili, že vaše nápovědní soubory používají správné kódování, dodržujte tyto pokyny:

  • Při používání PowerShell příkazů pro zápis do souborů nastavte kódovací parametr na utf8, utf8BOM, nebo utf8NoBOM.
  • Při vytváření nebo úpravě nápovědních souborů v textovém editoru jej nastavte tak, aby ukládal soubory ve formátu UTF-8. Pro nastavení kódování souboru se podívejte do dokumentace svého editora.

Example

Nesplňující

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Kompatibilní

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Viz také

Další informace najdete v následujících článcích:

  • Last updated on