Comparteix a través de

CA1512: Usar el ayudante de lanzamiento ArgumentOutOfRangeException

Propiedad Valor
Identificador de la regla CA1512
Título Utilice el ayudante de lanzamiento ArgumentOutOfRangeException
Categoría Capacidad de mantenimiento
La corrección interrumpe o no interrumpe No problemática
Habilitado de forma predeterminada en .NET 10 Como sugerencia
Idiomas aplicables C# y Visual Basic

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 integración en línea y provocan una contaminación sustancial de la caché de instrucciones. Los métodos "throw-helper" como ArgumentOutOfRangeException.ThrowIfGreaterThan son más sencillos y eficaces que los 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 auxiliares de lanzamiento:

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 la mantenibilidad de su código. También es apropiado suprimir las infracciones que se han identificado 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.

  • Last updated on