CA1721 : Les noms des propriétés ne doivent pas être identiques à ceux des méthodes Get

  • Article
Propriété Value
Identificateur de la règle CA1721
Titre Les noms des propriétés ne doivent pas être identiques à ceux des méthodes Get
Catégorie Dénomination
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Non

Cause

Le nom d’un membre commence par « Get » et correspond au nom d’une propriété. Par exemple, un type qui contient une méthode nommée « GetColor » et une propriété nommée « Color » entraîne une violation de règle. Cette règle ne se déclenche pas si la propriété ou la méthode est marquée avec le ObsoleteAttribute.

Par défaut, cette règle examine uniquement les membres et propriétés visibles en externe, mais elle est configurable.

Description de la règle

Les méthodes et propriétés « Get » doivent porter des noms distinguant clairement leur fonction.

Les conventions de nommage fournissent une recherche commune pour les bibliothèques qui ciblent le common language runtime. Cette cohérence réduit la durée requise pour apprendre à utiliser une nouvelle bibliothèque de logiciels, et augmente la confiance des clients en ce qui concerne le développement de la bibliothèque par une personne qui a une expertise dans le développement de code managé.

Comment corriger les violations

Modifiez le nom afin qu’il ne corresponde pas au nom d’une méthode précédé de « Get ».

Quand supprimer les avertissements

Ne supprimez aucun avertissement de cette règle. Une exception à cette règle est si la méthode « Get » est provoquée par l’implémentation de l’interface IExtenderProvider.

Supprimer un avertissement

Si vous voulez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver et réactiver la règle.

#pragma warning disable CA1721
// The code that's violating the rule is on this line.
#pragma warning restore CA1721

Pour désactiver la règle sur un fichier, un dossier ou un projet, définissez sa gravité sur none dans le fichier de configuration.

[*.{cs,vb}]
dotnet_diagnostic.CA1721.severity = none

Pour plus d’informations, consultez Comment supprimer les avertissements de l’analyse de code.

Configurer le code à analyser

Utilisez l’option suivante pour configurer les parties de votre codebase sur lesquelles exécuter cette règle.

Vous pouvez configurer cette option pour cette règle uniquement, pour toutes les règles auxquelles elle s’applique ou pour toutes les règles de cette catégorie (Nommage) auxquelles elle s’applique. Pour plus d’informations, consultez Options de configuration des règles de qualité du code.

Inclure des surfaces d’API spécifiques

Vous pouvez configurer les parties de votre codebase sur lesquelles exécuter cette règle, en fonction de leur accessibilité. Par exemple, pour spécifier que la règle doit s’exécuter uniquement sur la surface d’API non publique, ajoutez la paire clé-valeur suivante à un fichier .editorconfig dans votre projet :

dotnet_code_quality.CAXXXX.api_surface = private, internal

Exemple

L’exemple suivant contient une méthode et une propriété qui enfreignent cette règle.

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