UseUTF8EncodingForHelpFile

Önem Derecesi: Uyarı

Açıklama

Bu kural, bir about_ yardım dosyasının UTF-8 kodlaması kullanmadığını algılar. Kural, yardım dosyalarının UTF-8 about_.help.txt kodlamasında kaydedildiğini doğrular. Dosyanın kodlamasını kontrol etmek için StreamReader sınıfının CurrentEncoding özelliğini kullanır.

Yardım dosyalarınızın doğru kodlamayı kullandığından emin olmak için şu yönergeleri takip edin:

  • Dosyalara PowerShell komutları kullanılırken, kodlama parametresini utf8, utf8BOM, veya utf8NoBOMolarak ayarlayın.
  • Bir metin düzenleyicide yardım dosyaları oluştururken veya düzenlerken, dosyaları UTF-8 formatında kaydedecek şekilde yapılandırın. Dosya kodlamasını ayarlama talimatları için düzenleyicinizin dokümantasyonlarına bakın.

Example

Standartlara Uygun Değil

$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

Ayrıca bakınız

Daha fazla bilgi için aşağıdaki makalelere bakın:

  • Last updated on