CA1511: Uso del asistente de inicio ArgumentException
| Propiedad | Value |
|---|---|
| Identificador de la regla | CA1511 |
| Título | Uso del asistente de inicio ArgumentException |
| Categoría | Capacidad de mantenimiento |
| La corrección es problemática o no problemática | No problemática |
| Habilitado de forma predeterminada en .NET 8 | Como sugerencia |
Causa
El código comprueba si un argumento es null o una cadena vacía y, a continuación, produce condicionalmente un ArgumentException.
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 ArgumentException.ThrowIfNullOrEmpty(String, String) son más sencillos y eficaces que bloques if que construyen una nueva instancia de excepción.
Ejemplo
El fragmento de código siguiente muestra una infracción de CA1511:
void M(string arg)
{
if (string.IsNullOrEmpty(arg))
throw new ArgumentException("", "arg");
}
En el siguiente fragmento de código se muestran la corrección:
void M(string arg)
{
ArgumentException.ThrowIfNullOrEmpty(arg);
}
Cómo corregir infracciones
Reemplace el bloque if que produce la excepción por una llamada a ArgumentException.ThrowIfNullOrEmpty(String, 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 CA1511
// The code that's violating the rule is on this line.
#pragma warning restore CA1511
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.CA1511.severity = none
Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.
