Sammlungsausdruck für „Empty“ verwenden (IDE0301)
Eigentum | Wert |
---|---|
Regel-ID | IDE0301 |
Titel | Sammlungsausdruck für „Empty“ verwenden |
Kategorie | Stil |
Unterkategorie | Sprachregeln (Präferenzen auf Ausdrucksebene) |
Anwendbare Sprachen | C# 12+ |
Optionen | dotnet_style_prefer_collection_expression |
Überblick
Diese Regel sucht nach Code ähnlich Array.Empty<T>()
(einem Methodenaufruf, der eine leere Auflistung zurückgibt) oder ImmutableArray<T>.Empty
(eine Eigenschaft, die eine leere Auflistung zurückgibt) und bietet an, ihn durch einen Auflistungsausdruck ([]
) zu ersetzen.
Optionen
Optionen geben das Verhalten an, das die Regel erzwingen soll. Informationen zum Konfigurieren von Optionen finden Sie unter Option format.
dotnet_style_prefer_collection_expression
Eigentum | Wert | Beschreibung |
---|---|---|
Name der Option | dotnet_style_prefer_collection_expression | |
Optionswerte | true | when_types_exactly_match |
Verwenden Sie Auflistungsausdrücke nur, wenn Typen exakt übereinstimmen, z. B. int[] i = Array.Empty<int>(); . |
when_types_loosely_match (.NET 9 und höhere Versionen)* |
Bevorzugen Sie die Verwendung von Auflistungsausdrücken, selbst wenn die Typen nur lose übereinstimmen, z. B. IEnumerable<int> i = Array.Empty<int>(); . Der Zieltyp muss mit dem Typ auf der rechten Seite übereinstimmen oder einer der folgenden Typen sein: IEnumerable<T>, ICollection<T>, IList<T>, IReadOnlyCollection<T>, IReadOnlyList<T>. |
|
false | never |
Deaktiviert die Regel. | |
Standardwert der Option | true in .NET 8when_types_loosely_match in .NET 9 und höheren Versionen |
*Die Codekorrektur, wenn diese Option verwendet wird, kann die Semantik des Codes ändern.
Beispiel
// Code with violations.
int[] i = Array.Empty<int>();
IEnumerable<int> j = Array.Empty<int>();
ReadOnlySpan<int> span = ReadOnlySpan<int>.Empty;
// Fixed code.
int[] i = [];
IEnumerable<int> j = [];
ReadOnlySpan<int> span = [];
Der folgende Codeausschnitt zeigt ein Beispiel mit einem benutzerdefinierten Typ.
public class Program
{
public static void Main()
{
// IDE0301 violation.
MyList<int> x = MyList<int>.Empty;
// IDE0301 fixed code.
MyList<int> x = [];
}
}
class MyList<T> : IEnumerable<T>
{
public static MyList<T> Empty { get; }
public IEnumerator<T> GetEnumerator() => default;
IEnumerator IEnumerable.GetEnumerator() => default;
}
Unterdrücken einer Warnung
Wenn Sie nur einen einzelnen Verstoß unterdrücken möchten, fügen Sie Ihrer Quelldatei Präprozessordirektiven hinzu, um die Regel zu deaktivieren und dann erneut zu aktivieren.
#pragma warning disable IDE0301
// The code that's violating the rule is on this line.
#pragma warning restore IDE0301
Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdateiauf none
fest.
[*.{cs,vb}]
dotnet_diagnostic.IDE0301.severity = none
Um alle Regeln im Code-Stil zu deaktivieren, setzen Sie den Schweregrad für die Kategorie in der KonfigurationsdateiStyle
auf none
.
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
Weitere Informationen finden Sie unter So unterdrücken Sie Codeanalysewarnungen.