Usar la expresión de colección para un valor vacío (IDE0301)

Artículo
02/07/2024

Propiedad	Value
Identificador de la regla	IDE0301
Título	Usar la expresión de colección para un valor vacío
Categoría	Estilo
Subcategoría	Reglas del lenguaje (preferencias de nivel de expresión)
Lenguajes aplicables	C# 12+
Opciones	`dotnet_style_prefer_collection_expression`

Información general

Esta regla busca código similar a Array.Empty<T>() (una llamada de método que devuelve una colección vacía) o ImmutableArray<T>.Empty (una propiedad que devuelve una colección vacía) y ofrece reemplazarlo por una expresión de colección ([]).

Opciones

Las opciones especifican el comportamiento que se quiere que aplique la regla. Para más información sobre cómo configurar opciones, consulte Formato de opción.

dotnet_style_prefer_collection_expression

Propiedad	Valor	Descripción
Nombre de la opción	dotnet_style_prefer_collection_expression
Valores de opción	`true` \| `when_types_exactly_match`	Prefiere usar expresiones de colección solo cuando los tipos coinciden exactamente, por ejemplo, `int[] i = Array.Empty<int>();`.
	`when_types_loosely_match` (.NET 9 y versiones posteriores)^*	Prefiere usar expresiones de colección incluso cuando los tipos coinciden de forma flexible, por ejemplo, `IEnumerable<int> i = Array.Empty<int>();`. El tipo de destino debe coincidir con el tipo en el lado derecho o ser uno de los siguientes tipos: IEnumerable<T>, ICollection<T>, IList<T>, IReadOnlyCollection<T>, IReadOnlyList<T>.
	`false` \| `never`	Deshabilita la regla.
Valor de opción predeterminado	`true` en .NET 8 `when_types_loosely_match` en .NET 9 y versiones posteriores

^*La corrección de código cuando se usa esta opción puede cambiar la semántica del código.

Ejemplo

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

En el fragmento de código siguiente se muestra un ejemplo con un tipo personalizado.

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;
}

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para deshabilitar todas las reglas de estilo del código, establezca la gravedad de la categoría Style en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Consulte también

Usar la expresión de colección para una matriz (IDE0300)

Compartir vía