CA1512: Uso del asistente de inicio ArgumentOutOfRangeException

Propiedad	Value
Identificador de la regla	CA1512
Título	Uso del asistente de inicio ArgumentOutOfRangeException
Categoría	Capacidad de mantenimiento
La corrección es problemática o no problemática	No problemática
Habilitado de forma predeterminada en .NET 9	Como sugerencia

Causa

El código comprueba si un argumento es menor o mayor que un valor determinado y, a continuación, produce condicionalmente un ArgumentOutOfRangeException.

Descripción de la regla

Las comprobaciones de argumentos tienen un impacto considerable en el tamaño del código y suelen dominar el código para funciones pequeñas y establecedores de propiedades. Estas comprobaciones impiden la inserción y provocan una contaminación sustancial de la caché de instrucciones. Los métodos de asistentes de inicio como ArgumentOutOfRangeException.ThrowIfGreaterThan son más sencillos y eficaces que bloques if que construyen una nueva instancia de excepción.

Ejemplo

En el siguiente fragmento de código se muestran las infracciones de CA1512:

void M(int arg)
{
    if (arg is 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg < 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg <= 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg <= 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg < 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg > 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg >= 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg == 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg != 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
}

En el siguiente fragmento de código se muestran las correcciones:

void M(int arg)
{
    ArgumentOutOfRangeException.ThrowIfZero(arg);
    ArgumentOutOfRangeException.ThrowIfNegative(arg);
    ArgumentOutOfRangeException.ThrowIfNegativeOrZero(arg);
    ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfLessThan(arg, 42);
    ArgumentOutOfRangeException.ThrowIfGreaterThan(arg, 42);
    ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfNotEqual(arg, 42);
}

Cómo corregir infracciones

Reemplace el bloque if que produce la excepción por una llamada a uno de los siguientes métodos de asistente de inicio:

• ArgumentOutOfRangeException.ThrowIfZero<T>(T, String)
• ArgumentOutOfRangeException.ThrowIfNegative<T>(T, String)
• ArgumentOutOfRangeException.ThrowIfNegativeOrZero<T>(T, String)
• ArgumentOutOfRangeException.ThrowIfLessThanOrEqual<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfLessThan<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfGreaterThan<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfEqual<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfNotEqual<T>(T, T, String)

O bien, en Visual Studio, use el menú de bombilla para corregir el código automáticamente.

Cuándo suprimir las advertencias

Es seguro suprimir una infracción de esta regla si no le preocupa el mantenimiento del código. También es preciso suprimir las infracciones que se identifican como falsos positivos.

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

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

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