| description | ms.date | ms.topic | title |
|---|---|---|---|
Use UTF8 Encoding For Help File |
01/07/2025 |
reference |
UseUTF8EncodingForHelpFile |
Severity Level: Warning
Check that an about_ help file uses UTF-8 encoding. The filename must start with about_ and end
with .help.txt. The rule uses the CurrentEncoding property of the StreamReader class to
determine the encoding of the file.
For PowerShell commands that write to files, ensure that you set the encoding parameter to utf8,
utf8BOM, or utf8NoBOM.
When you create a help file using a text editor, ensure that the editor is configured to save the file in a UTF8 format. Consult the documentation for your text editor for instructions on how to save files with a specific encoding.
For more information, see the following articles: