CA1513: Uso de la función auxiliar ObjectDisposedException

Propiedad	Valor
Identificador de la regla	CA1513
Título	Utilizar el método auxiliar (throw helper) de ObjectDisposedException
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 se elimina un objeto y, a continuación, produce condicionalmente un ObjectDisposedException.

Descripción de la regla

Las comprobaciones de objetos 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 ThrowIf son más sencillos y eficaces que los bloques if que construyen una nueva instancia de excepción.

Ejemplo

El fragmento de código siguiente muestra una infracción de CA1513:

class C
{
    private bool _disposed = false;
    void M()
    {
        if (_disposed)
            throw new ObjectDisposedException(GetType().Name);
    }
}

En el siguiente fragmento de código se muestra la solución:

class C
{
    private bool _disposed = false;
    void M()
    {
        ObjectDisposedException.ThrowIf(_disposed, this);
    }
}

Cómo corregir infracciones

Reemplace el bloque if que produce la excepción por una llamada a ThrowIf. 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 CA1513
// The code that's violating the rule is on this line.
#pragma warning restore CA1513

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

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