Teilen über

Sammlungsausdruck für Create() verwenden (IDE0303)

  • Artikel
Eigenschaft Wert
Regel-ID IDE0303
Titel Sammlungsausdruck für „Create“ 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 eine Create()-Methode oder eine ähnliche Methode, die als Sammlungserstellungsmethode (mithilfe des CollectionBuilderAttribute-Attributs) festgelegt ist, zur Initialisierung einer Sammlung verwendet wird. Außerdem bietet sie an, sie durch einen Sammlungsausdruck ([...]) zu ersetzen.

Create()-Methoden sind für die unveränderlichen Sammlungen üblich, etwa ImmutableArray.Create(1, 2, 3).

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, z. B. ImmutableArray<int> i = ImmutableArray.Create(1, 2, 3);.
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 = ImmutableArray.Create(1, 2, 3);. 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.
ImmutableArray<int> i = ImmutableArray.Create(1, 2, 3);
IEnumerable<int> j = ImmutableArray.Create(1, 2, 3);

// Fixed code.
ImmutableArray<int> i = [1, 2, 3];
IEnumerable<int> j = [1, 2, 3];

Der folgende Codeschnipsel zeigt ein Beispiel mit einem benutzerdefinierten Typ, der mit der Anmerkung CollectionBuilderAttribute versehen ist.

public class Program
{
    public static void Main()
    {
        // IDE0303 violation.
        MyCollection<int> c = MyCollection.Create(1, 2, 3);

        // IDE0303 fixed code.
        MyCollection<int> c = [1, 2, 3];
    }
}

static partial class MyCollection
{
    public static MyCollection<T> Create<T>(System.ReadOnlySpan<T> values) => default;
    public static MyCollection<T> Create<T>(T t1, T t2, T t3) => default;
}

[CollectionBuilder(typeof(MyCollection), "Create")]
class MyCollection<T> : IEnumerable<T>
{
    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 IDE0303
// The code that's violating the rule is on this line.
#pragma warning restore IDE0303

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