UseUTF8EncodingForHelpFile

ernstniveau: waarschuwing

Beschrijving

Deze regel detecteert wanneer een about_ hulpbestand geen UTF-8-codering gebruikt. De regel verifieert dat hulpbestanden die beginnen met about_ en eindigen met .help.txt worden opgeslagen in UTF-8-codering. Het gebruikt de CurrentEncoding-eigenschap van de StreamReader-klasse om de codering van het bestand te controleren.

Om ervoor te zorgen dat je helpbestanden de juiste codering gebruiken, volg je deze richtlijnen:

• Wanneer PowerShell-commando's worden gebruikt om naar bestanden te schrijven, stel je de coderingsparameter in op utf8, utf8BOM, of utf8NoBOM.
• Wanneer je hulpbestanden maakt of bewerkt in een teksteditor, configureer deze dan om bestanden op te slaan in UTF-8-formaat. Raadpleeg de documentatie van je redacteur voor instructies over het instellen van de bestandscodering.

Example

Niet conform

$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

Zie ook

Zie de volgende artikelen voor meer informatie:

• System.IO.StreamReader-
• about_Character_Encoding
• set-content
• Bestandscodering begrijpen in Visual Studio Code en PowerShell