Usar expressão de coleção para vazio (IDE0301)

Artigo
01/30/2024

Property	valor
ID da regra	IDE0301
Título	Usar expressão de coleção para vazio
Categoria	Estilo
Subcategoria	Regras de idioma (preferências no nível da expressão)
Línguas aplicáveis	C# 12+
Opções	`dotnet_style_prefer_collection_expression`

Descrição geral

Esta regra procura um código semelhante a (uma chamada de Array.Empty<T>() método que retorna uma coleção vazia) ou ImmutableArray<T>.Empty (uma propriedade que retorna uma coleção vazia) e oferece para substituí-la por uma expressão de coleção ([]).

Opções

As opções especificam o comportamento que você deseja que a regra imponha . Para obter informações sobre como configurar opções, consulte Formato de opção.

dotnet_style_prefer_collection_expression

Property	valor	Description
Nome da opção	dotnet_style_prefer_collection_expression
Valores de opção	`true` \| `when_types_exactly_match`	Prefira usar expressões de coleção somente quando os tipos corresponderem exatamente, por exemplo, `int[] i = Array.Empty<int>();`.
	`when_types_loosely_match` (.NET 9 e versões posteriores)^*	Prefira usar expressões de coleção mesmo quando os tipos correspondem vagamente, por exemplo, `IEnumerable<int> i = Array.Empty<int>();`. O tipo visado deve corresponder ao tipo do lado direito ou ser um dos seguintes tipos: IEnumerable<T>, , , , IReadOnlyCollection<T>ICollection<T>IList<T>IReadOnlyList<T>.
	`false` \| `never`	Desativa a regra.
Valor da opção padrão	`true` no .NET 8 `when_types_loosely_match` no .NET 9 e versões posteriores

^*A correção de código quando essa opção é usada pode alterar a semântica do seu código.

Exemplo

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

O trecho de código a seguir mostra um exemplo com um 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;
}

Suprimir um aviso

Se você quiser suprimir apenas uma única violação, adicione diretivas de pré-processador ao arquivo de origem para desativar e, em seguida, reativar a regra.

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

Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.

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

Para desabilitar todas as regras de estilo de código, defina a severidade da categoria Style como none no arquivo de configuração.

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

Para obter mais informações, consulte Como suprimir avisos de análise de código.

Consulte também

Usar expressão de coleção para matriz (IDE0300)

Partilhar via