CA1043: Utilizzare argomento di tipo stringa o integrale per gli indicizzatori

  • Articolo
Proprietà valore
ID regola CA1043
Titolo Usare un argomento di tipo stringa o integrale per gli indicizzatori
Categoria Progettazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Un tipo contiene un indicizzatore che usa un tipo di indice diverso da System.Int32, System.Int64System.Object, o System.String.

Per impostazione predefinita, questa regola esamina solo i tipi visibili esternamente, ma è configurabile.

Descrizione regola

Gli indicizzatori, ovvero le proprietà indicizzate, devono usare tipi integer o stringa per l'indice. Questi tipi vengono in genere usati per l'indicizzazione di strutture di dati e aumentano l'usabilità della libreria. L'uso del Object tipo deve essere limitato a tali casi in cui non è possibile specificare il tipo intero o stringa specifico in fase di progettazione. Se la progettazione richiede altri tipi per l'indice, riconsiderare se il tipo rappresenta un archivio dati logico. Se non rappresenta un archivio dati logico, usare un metodo .

Come correggere le violazioni

Per correggere una violazione di questa regola, modificare l'indice in un tipo integer o stringa oppure usare un metodo anziché l'indicizzatore.

Quando eliminare gli avvisi

Eliminare un avviso da questa regola solo dopo aver considerato attentamente la necessità dell'indicizzatore non standard.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (Progettazione) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Esempio

Nell'esempio seguente viene illustrato un indicizzatore che usa un Int32 indice.

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