UseUTF8EncodingForHelpFile

súlyossági szint: Figyelmeztetési

Leírás

Ez a szabály akkor érzékeli, ha egy about_ súgófájl nem használ UTF-8 kódolást. A szabály igazolja, hogy a súgó about_.help.txt fájlok az UTF-8 kódolásban vannak elmentve. A StreamReader osztály CurrentEncoding tulajdonságát használja a fájl kódolásának ellenőrzésére.

Annak érdekében, hogy a segítő fájljaid a megfelelő kódolást használják, kövesd ezeket az irányelveket:

  • PowerShell parancsokat használva fájlokat írunk, állítsuk be a kódolási paramétert , utf8utf8BOM, vagy utf8NoBOM.
  • A súgófájlokat létrehozva vagy szerkesztésekor szövegszerkesztőben konfiguráld be, hogy UTF-8 formátumban mentse a fájlokat. Nézd meg a szerkesztőd dokumentációját a fájlkódolás beállításához szükséges utasításokért.

Example

Nem megfelelő

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Megfelelő

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Lásd még

További információkért lásd a következő cikkeket:

  • Last updated on