UseUTF8EncodingForHelpFile

Tingkat Keparahan : Peringatan

Deskripsi

Aturan ini mendeteksi saat about_ file bantuan tidak menggunakan pengodean UTF-8. Aturan memverifikasi bahwa file bantuan yang dimulai dengan about_ dan diakhiri dengan .help.txt disimpan dalam pengkodean UTF-8. Ini menggunakan properti CurrentEncoding dari kelas StreamReader untuk memeriksa pengkodean file.

Untuk memastikan file bantuan Anda menggunakan pengodean yang benar, ikuti panduan berikut:

• Saat menggunakan perintah PowerShell untuk menulis ke file, atur parameter pengodean ke utf8, utf8BOM, atau utf8NoBOM.
• Saat membuat atau mengedit file bantuan di editor teks, konfigurasikan untuk menyimpan file dalam format UTF-8. Lihat dokumentasi editor Anda untuk petunjuk tentang pengaturan pengkodean file.

Example

Tidak sesuai

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

$helpText | Set-Content -Path "about_Contoso.help.txt" -Encoding Unicode

Sesuai

$helpText = @'
TOPIC
  about_Contoso

SHORT DESCRIPTION
  Describes Contoso commands.
'@

$helpText | Set-Content -Path "about_Contoso.help.txt" -Encoding utf8NoBOM

Baca juga

Untuk informasi selengkapnya, lihat artikel berikut ini:

• System.IO.StreamReader
• about_Character_Encoding
• Set-Content
• Memahami pengkodean file di Visual Studio Code dan PowerShell