Gyűjteménykifejezés használata ( Create()
IDE0303)
Tulajdonság | Érték |
---|---|
Szabályazonosító | IDE0303 |
Cím | Gyűjteménykifejezés használata a Létrehozáshoz |
Kategória | Stílus |
Alkategória | Nyelvi szabályok (kifejezésszintű beállítások) |
Alkalmazandó nyelvek | C# 12+ |
Beállítások | dotnet_style_prefer_collection_expression |
Áttekintés
Ez a szabály megjelöli azokat a helyeket, ahol a Create()
gyűjteményépítési módszerként (az CollectionBuilderAttribute attribútum használatával) kijelölt metódus vagy hasonló metódus egy gyűjtemény inicializálására szolgál, és felajánlja a gyűjtemény kifejezésre ([...]
) való lecserélését.
Create()
metódusok gyakran előfordulnak a nem módosítható gyűjteményekben, ImmutableArray.Create(1, 2, 3)
például.
Feljegyzés
Ez a szabály a nem módosítható API-k (például) újabb verzióit igényli, System.Collections.Immutableamelyek a gyűjteménykifejezési mintát választják.
Beállítások
A beállítások határozzák meg a szabály kényszerítéséhez használni kívánt viselkedést. A beállítások konfigurálásával kapcsolatos információkért tekintse meg az Option formátumot.
dotnet_style_prefer_collection_expression
Tulajdonság | Érték | Leírás |
---|---|---|
Beállítás neve | dotnet_style_prefer_collection_expression | |
Beállításértékek | true | when_types_exactly_match |
Inkább csak akkor használjon gyűjteménykifejezéseket, ha a típusok pontosan egyeznek, például ImmutableArray<int> i = ImmutableArray.Create(1, 2, 3); . |
when_types_loosely_match (.NET 9 és újabb verziók)* |
A gyűjteménykifejezéseket akkor is érdemes használni, ha például a típusok lazán egyeznek. IEnumerable<int> i = ImmutableArray.Create(1, 2, 3); A megcélzott típusnak meg kell egyeznie a jobb oldali típussal, vagy a következő típusok egyikének kell lennie: IEnumerable<T>, , , IList<T>, IReadOnlyCollection<T>IReadOnlyList<T>. ICollection<T> |
|
false | never |
Letiltja a szabályt. | |
Alapértelmezett beállításérték | true a .NET 8-banwhen_types_loosely_match .NET 9 és újabb verziókban |
*Ha ezt a beállítást használja, a kód kijavítása megváltoztathatja a kód szemantikáját.
Példa
// 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];
Az alábbi kódrészlet egy példát mutat be egy egyéni típussal, amely megjegyzésekkel CollectionBuilderAttributevan elkönyvelve.
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;
}
Figyelmeztetés mellőzése
Ha csak egyetlen szabálysértést szeretne letiltani, adjon hozzá előfeldolgozási irányelveket a forrásfájlhoz a szabály letiltásához és újbóli engedélyezéséhez.
#pragma warning disable IDE0303
// The code that's violating the rule is on this line.
#pragma warning restore IDE0303
Ha le szeretné tiltani egy fájl, mappa vagy projekt szabályát, állítsa annak súlyosságát none
a konfigurációs fájlban.
[*.{cs,vb}]
dotnet_diagnostic.IDE0303.severity = none
Az összes kódstílus-szabály letiltásához állítsa be a kategória Style
súlyosságát none
a konfigurációs fájlban.
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
További információ: Kódelemzési figyelmeztetések letiltása.