UseUTF8EncodingForHelpFile

Nivel de gravedad de : advertencia

Descripción

Esta regla detecta cuando un about_ archivo de ayuda no utiliza codificación UTF-8. La regla verifica que los archivos de ayuda que empiezan y about_ terminan con .help.txt están guardados en la codificación UTF-8. Utiliza la propiedad CurrentEncoding de la clase StreamReader para comprobar la codificación del archivo.

Para asegurarte de que tus archivos de ayuda usen la codificación correcta, sigue estas directrices:

  • Al usar comandos PowerShell para escribir en archivos, establece el parámetro de codificación en utf8, utf8BOM, o utf8NoBOM.
  • Al crear o editar archivos de ayuda en un editor de texto, configúralo para guardar archivos en formato UTF-8. Consulta la documentación de tu editor para obtener instrucciones sobre cómo configurar la codificación del archivo.

Example

No 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

Consulte también

Para obtener más información, consulte los artículos siguientes:

  • Last updated on