CA1043: Usar argumento integral ou de cadeia de caracteres para indexadores

  • Artigo
Property Valor
ID da regra CA1043
Título Usar argumento integral ou de cadeia de caracteres para indexadores
Categoria Projetar
Correção interruptiva ou sem interrupção Quebra
Habilitado por padrão no .NET 8 Não

Causa

Um tipo contém um indexador que usa um tipo de índice diferente de System.Int32, System.Int64, System.Object ou System.String.

Por padrão, essa regra apenas analisa os tipos visíveis externamente, mas isso é configurável.

Descrição da regra

Os indicadores (ou seja, propriedades indexadas) devem usar tipos inteiros ou de cadeia de caracteres no índice. Esses tipos normalmente são usados na indexação de estruturas de dados e aumentam a usabilidade da biblioteca. O uso do tipo Object deve ser restrito a esses casos em que o tipo inteiro ou de cadeia de caracteres específico não pode ser especificado no tempo de design. Se o design exigir outros tipos para o índice, reconsidere se o tipo representa um armazenamento lógico de dados. Se ele não representar um armazenamento lógico de dados, use um método.

Como corrigir violações

Para corrigir uma violação dessa regra, altere o índice para um tipo de cadeia de caracteres ou inteiro ou use um método em vez do indexador.

Quando suprimir avisos

Suprima um aviso dessa regra somente depois de considerar cuidadosamente a necessidade do indexador não padrão.

Suprimir um aviso

Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar a regra.

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

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

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

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

Configurar código para analisar

Use a opção a seguir para configurar em quais partes da base de código essa regra deve ser executada.

Você pode configurar essa opção apenas para essa regra, para todas as regras às quais ela se aplica ou para todas as regras nessa categoria (Design) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.

Incluir superfícies de API específicas

É possível configurar em quais partes da base de código essa regra deverá ser executada, com base na acessibilidade. Por exemplo, para especificar que a regra deverá ser executada apenas na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig no projeto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Exemplo

O exemplo a seguir mostra um indexador que usa um índice Int32.

string[] Month = new string[] { "Jan", "Feb", "..." };

public string this[int index]
{
    get => Month[index];
}

Private month() As String = {"Jan", "Feb", "..."}

Default ReadOnly Property Item(index As Integer) As String
    Get
        Return month(index)
    End Get
End Property