UseUTF8EncodingForHelpFile

livello di gravità : avviso

Descrizione

Questa regola rileva quando un about_ file di aiuto non utilizza la codifica UTF-8. La regola verifica che i file di aiuto che iniziano e about_ terminano con .help.txt sono salvati in codifica UTF-8. Utilizza la proprietà CurrentEncoding della classe StreamReader per controllare la codifica del file.

Per assicurarti che i tuoi file di aiuto utilizzino la codifica corretta, segui queste linee guida:

• Quando si usano comandi PowerShell per scrivere nei file, imposta il parametro di codifica su utf8, utf8BOM, o utf8NoBOM.
• Quando crei o modifichi file di aiuto in un editor di testo, configuralo per salvare i file in formato UTF-8. Consulta la documentazione del tuo editor per istruzioni su come impostare la codifica del file.

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

Vedere anche

Per altre informazioni, vedere gli articoli seguenti:

• System.IO.StreamReader
• about_Character_Encoding
• set-content
• Comprendere la codifica dei file in Visual Studio Code e PowerShell