Sammlungsausdruck für Generator verwenden (IDE0304)

  • Artikel
Eigenschaft Wert
Regel-ID IDE0304
Titel Sammlungsausdruck für Generator verwenden
Kategorie Stil
Unterkategorie Sprachregeln (Einstellungen auf Ausdrucksebene)
Gültige Sprachen C# 12+
Optionen dotnet_style_prefer_collection_expression

Überblick

Diese Regel kennzeichnet Stellen, an denen CreateBuilder() oder eine ähnliche Methode zum Erstellen eines Generatortyps aufgerufen wird, der Elemente hinzufügt und schließlich einen Sammlungstyp mit dem CollectionBuilderAttribute-Attribut erstellt (z. B. durch Aufrufen von ImmutableArray<T>.Builder.ToImmutable()). Stattdessen könnte ein Sammlungsausdruck ([...]) verwendet werden, um die Auflistung zu initialisieren.

Hinweis

Diese Regel erfordert neuere Versionen der unveränderlichen APIs (z. B. System.Collections.Immutable), die das Sammlungsausdrucksmuster aktivieren.

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.
when_types_loosely_match
(.NET 9 und höhere Versionen)*		 Verwenden Sie Auflistungsausdrücke lieber auch dann, wenn Typen grob übereinstimmen. 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 violation.
var builder = ImmutableArray.CreateBuilder<int>();
builder.Add(1);
builder.AddRange(new int[] { 5, 6, 7 });
ImmutableArray<int> i = builder.ToImmutable();

// Fixed code.
ImmutableArray<int> i = [1, .. new int[] { 5, 6, 7 }];

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 IDE0304
// The code that's violating the rule is on this line.
#pragma warning restore IDE0304

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.IDE0304.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