Use UTF-8 string literal (IDE0230)
Property | Value |
---|---|
Rule ID | IDE0230 |
Title | Use UTF-8 string literal |
Category | Style |
Subcategory | Language rules (expression-level preferences) |
Applicable languages | C# 11+ |
Options | csharp_style_prefer_utf8_string_literals |
Overview
This rule flags the use of a byte array (byte[]
) where a UTF-8 string literal could be used instead. Using a UTF-8 string literal adds clarity to the declaration.
Options
Options specify the behavior that you want the rule to enforce. For information about configuring options, see Option format.
csharp_style_prefer_utf8_string_literals
Property | Value | Description |
---|---|---|
Option name | csharp_style_prefer_utf8_string_literals | |
Option values | true |
Prefer UTF-8 string literals to byte arrays. |
false |
Disables the rule. | |
Default option value | true |
Example
// Code with violations.
ReadOnlySpan<byte> _ = new byte[] { 65, 66, 67 };
// Fixed code.
ReadOnlySpan<byte> _ = "ABC"u8;
Suppress a warning
If you want to suppress only a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.
#pragma warning disable IDE0230
// The code that's violating the rule is on this line.
#pragma warning restore IDE0230
To disable the rule for a file, folder, or project, set its severity to none
in the configuration file.
[*.{cs,vb}]
dotnet_diagnostic.IDE0230.severity = none
To disable all of the code-style rules, set the severity for the category Style
to none
in the configuration file.
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
For more information, see How to suppress code analysis warnings.