UseUTF8EncodingForHelpFile

Schweregrad: Warnung

Beschreibung

Diese Regel erkennt, wenn eine about_ Hilfedatei keine UTF-8-Codierung verwendet. Die Regel überprüft, dass Hilfedateien, die mit about_ und mit enden, .help.txt in der UTF-8-Codierung gespeichert werden. Es verwendet die CurrentEncoding-Eigenschaft der StreamReader-Klasse , um die Kodierung der Datei zu überprüfen.

Um sicherzustellen, dass Ihre Hilfedateien die korrekte Codierung verwenden, befolgen Sie diese Richtlinien:

  • Wenn Sie PowerShell-Befehle verwenden, um Dateien zu schreiben, setzen Sie den Codierungsparameter auf utf8, utf8BOM, oder utf8NoBOM.
  • Wenn Sie Hilfsdateien in einem Texteditor erstellen oder bearbeiten, konfigurieren Sie ihn so, dass Dateien im UTF-8-Format gespeichert werden. Konsultiere die Dokumentation deines Redakteurs für Anweisungen zur Einstellung der Dateikodierung.

Example

Nicht konform

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Konform

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

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

Siehe auch

Weitere Informationen finden Sie in den folgenden Artikeln:

  • Last updated on