UseUTF8EncodingForHelpFile

niveau de gravité : avertissement

Description

Cette règle détecte lorsqu’un about_ fichier d’aide n’utilise pas l’encodage UTF-8. La règle vérifie que les fichiers d’aide commençant par about_ et se terminant par .help.txt sont sauvegardés en encodage UTF-8. Il utilise la propriété CurrentEncoding de la classe StreamReader pour vérifier l’encodage du fichier.

Pour garantir que vos fichiers d’aide utilisent le bon encodage, suivez ces directives :

  • Lorsque vous utilisez des commandes PowerShell pour écrire dans des fichiers, réglez le paramètre d’encodage sur utf8, utf8BOM, ou utf8NoBOM.
  • Lorsque vous créez ou modifiez des fichiers d’aide dans un éditeur de texte, configurez-le pour enregistrer les fichiers au format UTF-8. Consultez la documentation de votre éditeur pour obtenir des instructions sur la configuration de l’encodage du fichier.

Example

Non conforme

$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

Voir aussi

Pour plus d’informations, consultez les articles suivants :

  • Last updated on