CA1043: Utilizar un argumento integral o de cadena en indizadores

  • Artículo
Propiedad Value
Identificador de la regla CA1043
Título Utilizar un argumento integral o de cadena en indizadores
Categoría Diseño
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Un tipo contiene un indizador que usa un tipo de índice distinto de System.Int32, System.Int64, System.Object o System.String.

De forma predeterminada, esta regla solo examina los tipos visibles externamente, pero es configurable.

Descripción de la regla

Los indizadores,es decir, las propiedades indizadas, deben utilizar tipos enteros o de cadena para el índice. Estos tipos se utilizan normalmente para indizar las estructuras de datos y aumentan la facilidad de uso de la biblioteca. El uso del tipo Object debería limitarse a los casos en los que el tipo entero o de cadena en concreto no se puede especificar en tiempo de diseño. Si el diseño requiere otros tipos para el índice, replantéese si el tipo representa un almacén de datos lógico. Si no representa un almacén de datos lógico, use un método.

Cómo corregir infracciones

Para corregir una infracción de esta regla, cambie el índice a un tipo entero o de cadena, o bien use un método en lugar del indizador.

Cuándo suprimir las advertencias

Suprima una advertencia de esta regla solo después de considerar detenidamente la necesidad de utilizar el indizador no estándar.

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 CA1043
// The code that's violating the rule is on this line.
#pragma warning restore CA1043

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.CA1043.severity = none

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

Configuración del código para analizar

Use la opción siguiente para configurar en qué partes del código base ejecutar esta regla.

Puede configurar esta opción solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Diseño) a las que se aplica. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Ejemplo

En el ejemplo siguiente se muestra un indizador que utiliza un í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