CA2011: No asignar la propiedad dentro de su establecedor
Propiedad | Value |
---|---|
Identificador de la regla | CA2011 |
Título | No asignar la propiedad dentro de su establecedor |
Categoría | Confiabilidad |
La corrección es problemática o no problemática | Poco problemático |
Habilitado de forma predeterminada en .NET 8 | Como sugerencia |
Causa
Se ha asignado por error un valor a una propiedad dentro de su propio descriptor de acceso set.
Descripción de la regla
Asignar una propiedad a sí misma en su descriptor de acceso set produce una cadena infinita de llamadas recursivas al descriptor de acceso set, lo que conlleva un elemento StackOverflowException en tiempo de ejecución. Este error es habitual cuando la propiedad y el campo de respaldo para almacenar el valor de propiedad tienen nombres parecidos. En lugar de asignar el valor al campo de respaldo, se asignó accidentalmente a la propiedad.
Cómo corregir infracciones
Para corregir infracciones, reemplace la asignación que produce la infracción a la propiedad por una asignación al campo de respaldo bien cambie para usar una propiedad automática. Por ejemplo, el siguiente fragmento de código muestra una infracción de la regla y dos maneras de corregirla:
public class C
{
// Backing field for property 'P'
private int p;
public int P
{
get
{
return p;
}
set
{
// CA2011: Accidentally assigned to property, instead of the backing field.
P = value;
}
}
}
public class C
{
// Backing field for property 'P'
private int _p;
public int P
{
get
{
return _p;
}
set
{
// Option 1: Assign to backing field and rename the backing field for clarity.
_p = value;
}
}
}
public class C
{
// Option 2: Use auto-property.
public int P { get; set; }
}
Cuándo suprimir las advertencias
Las infracciones de esta regla se pueden suprimir si está seguro de que las llamadas recursivas al descriptor de acceso set están protegidas condicionalmente para evitar una recursividad infinita.
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 CA2011
// The code that's violating the rule is on this line.
#pragma warning restore CA2011
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.CA2011.severity = none
Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.