Använda samlingsuttryck för builder (IDE0304)

Artikel
01/31/2024

Property	Värde
Regel-ID	IDE0304
Title	Använda samlingsuttryck för builder
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 flaggar platser där en CreateBuilder() eller liknande metod anropas för att skapa en builder-typ som lägger till element och slutligen skapar en samlingstyp som har CollectionBuilderAttribute attributet (till exempel genom att anropa ImmutableArray<T>.Builder.ToImmutable()). I stället kan ett samlingsuttryck ([...]) användas för att initiera samlingen.

Kommentar

Den här regeln kräver nyare versioner av oföränderliga API:er (till exempel System.Collections.Immutable), som väljer mönstret för 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.
	`when_types_loosely_match` (.NET 9 och senare versioner)^*	Föredrar att använda samlingsuttryck även när typerna matchar löst. 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 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 }];

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

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

Dela via