UseUTF8EncodingForHelpFile

уровень серьезности : предупреждение

Описание

Это правило определяет, когда about_ файл помощи не использует кодирование UTF-8. Правило проверяет, что файлы справки, начинающиеся с about_ и заканчивающиеся .help.txt , сохраняются в кодировке UTF-8. Для проверки кодировки файла используется свойство CurrentEncoding класса StreamReader .

Чтобы ваши файлы поддержки использовали правильное кодирование, следуйте следующим рекомендациям:

• При использовании команд PowerShell для записи в файлы установите параметр кодирования на utf8, utf8BOM, или utf8NoBOM.
• При создании или редактировании файлов помощи в текстовом редакторе настройте его на сохранение файлов в формате UTF-8. Обратитесь к документации вашего редактора для инструкций по настройке кодировки файла.

Пример

Несоответствующий

$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

См. также

Дополнительные сведения см. в следующих статьях:

• System.IO.StreamReader
• about_Character_Encoding
• set-Content
• Понимание кодирования файлов в Visual Studio Code и PowerShell