Sammlungsausdruck für „Empty“ verwenden (IDE0301)

Artikel
01/31/2024

Eigenschaft	Wert
Regel-ID	IDE0301
Titel	Sammlungsausdruck für „Empty“ verwenden
Kategorie	Stil
Unterkategorie	Sprachregeln (Einstellungen auf Ausdrucksebene)
Gültige Sprachen	C# 12+
Optionen	`dotnet_style_prefer_collection_expression`

Überblick

Diese Regel sucht nach Code ähnlich Array.Empty<T>() (einem Methodenaufruf, der eine leere Sammlung zurückgibt) oder ImmutableArray<T>.Empty (eine Eigenschaft, die eine leere Sammlung zurückgibt) und bietet an, ihn durch einen Sammlungsausdruck ([]) zu ersetzen.

Optionen

Optionen geben das Verhalten an, das die Regel erzwingen soll. Informationen zum Konfigurieren von Optionen finden Sie unter Optionsformat.

dotnet_style_prefer_collection_expression

Eigenschaft	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)^*	Verwenden Sie Auflistungsausdrücke lieber auch dann, wenn Typen grob ü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`	Die Regel wird deaktiviert.
Standardoptionswert	`true` in .NET 8 `when_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 Codeschnipsel 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

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder 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 Konfigurationsdatei auf 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 Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Siehe auch

Sammlungsausdruck für Array verwenden (IDE0300)

Teilen über