CA1721: Los nombres de propiedades no deben coincidir con los métodos get

  • Artículo
Propiedad Value
Identificador de la regla CA1721
Título Los nombres de propiedades no deben coincidir con los métodos get
Categoría Nomenclatura
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

El nombre de un miembro empieza con "Get" y en cualquier otro caso coincide con el nombre de una propiedad. Por ejemplo, un tipo que contiene un método denominado "GetColor" y una propiedad denominada "Color" provocan una infracción de la regla. Esta regla no se activará si la propiedad o el método están marcados con el atributo ObsoleteAttribute.

De forma predeterminada, esta regla solo examina los miembros y las propiedades visibles externamente, pero es configurable.

Descripción de la regla

Las propiedades y métodos "Get" deberían tener nombres que distingan claramente su función.

Las convenciones de nomenclatura proporcionan una apariencia común para las bibliotecas destinadas a Common Language Runtime. Esta coherencia reduce el tiempo necesario para aprender una nueva biblioteca de software y aumenta la confianza del cliente en que la biblioteca la ha desarrollado alguien con experiencia en desarrollo de código administrado.

Cómo corregir infracciones

Cambie el nombre para que no coincida con el nombre de un método que tenga el prefijo "Get".

Cuándo suprimir las advertencias

No suprima las advertencias de esta regla. Una excepción a esa regla es si el método «Get» se debe a la implementación de la IExtenderProvider interfaz.

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

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

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

Configuración del código para analizar

Use la opción siguiente para configurar en qué partes del código base ejecutar esta regla.

Puede configurar esta opción solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Nomenclatura) a las que se aplica. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Ejemplo

El ejemplo siguiente contiene un método y una propiedad que infringen esta regla.

public class Test
{
    public DateTime Date
    {
        get { return DateTime.Today; }
    }

    // Violates rule: PropertyNamesShouldNotMatchGetMethods.
    public string GetDate()
    {
        return this.Date.ToString();
    }
}

Imports System

Namespace ca1721

    Public Class Test

        Public ReadOnly Property [Date]() As DateTime
            Get
                Return DateTime.Today
            End Get
        End Property

        ' Violates rule: PropertyNamesShouldNotMatchGetMethods.
        Public Function GetDate() As String
            Return Me.Date.ToString()
        End Function

    End Class

End Namespace