Använd samlingsuttryck för tomt (IDE0301)

Artikel
01/30/2024

Property	Värde
Regel-ID	IDE0301
Title	Använd samlingsuttryck för tomt
Kategori	Format
Underkategori	Språkregler (inställningar på uttrycksnivå)
Tillämpliga språk	C# 12+
Alternativ	`dotnet_style_prefer_collection_expression`

Översikt

Den här regeln söker efter kod som liknar Array.Empty<T>() (ett metodanrop som returnerar en tom samling) eller ImmutableArray<T>.Empty (en egenskap som returnerar en tom samling) och erbjuder sig att ersätta den med ett samlingsuttryck ([]).

Alternativ

Alternativ anger det beteende som du vill att regeln ska framtvinga. Information om hur du konfigurerar alternativ finns i Alternativformat.

dotnet_style_prefer_collection_expression

Property	Värde	beskrivning
Alternativnamn	dotnet_style_prefer_collection_expression
Alternativvärden	`true` \| `when_types_exactly_match`	Föredrar att endast använda samlingsuttryck när typerna matchar exakt, till exempel `int[] i = Array.Empty<int>();`.
	`when_types_loosely_match` (.NET 9 och senare versioner)^*	Föredrar att använda samlingsuttryck även när typerna matchar löst, till exempel `IEnumerable<int> i = Array.Empty<int>();`. Måltypen måste matcha typen till höger eller vara någon av följande typer: IEnumerable<T>, ICollection<T>, IList<T>, IReadOnlyCollection<T>, IReadOnlyList<T>.
	`false` \| `never`	Inaktiverar regeln.
Standardalternativvärde	`true` i .NET 8 `when_types_loosely_match` i .NET 9 och senare versioner

^*Kodkorrigeringen när det här alternativet används kan ändra kodens semantik.

Exempel

// 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 = [];

Följande kodfragment visar ett exempel med en anpassad 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;
}

Ignorera en varning

Om du bara vill förhindra en enda överträdelse lägger du till förprocessordirektiv i källfilen för att inaktivera och återaktiverar sedan regeln.

#pragma warning disable IDE0301
// The code that's violating the rule is on this line.
#pragma warning restore IDE0301

Om du vill inaktivera regeln för en fil, mapp eller ett projekt anger du dess allvarlighetsgrad till none i konfigurationsfilen.

[*.{cs,vb}]
dotnet_diagnostic.IDE0301.severity = none

Om du vill inaktivera alla regler i kodformat anger du allvarlighetsgraden för kategorin Style till i konfigurationsfilen.none

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none

Mer information finns i Så här utelämnar du kodanalysvarningar.

Se även

Använda samlingsuttryck för matris (IDE0300)

Dela via