Sdílet prostřednictvím

CA1721: Názvy vlastností by neměly odpovídat metodám Get

  • Článek
Vlastnost Hodnota
ID pravidla CA1721
Název Názvy vlastností by se neměly shodovat s metodami Get
Kategorie Pojmenování
Oprava způsobující chybu nebo chybu způsobující chybu Narušující
Povoleno ve výchozím nastavení v .NET 8 No

Příčina

Název člena začíná na Get a jinak odpovídá názvu vlastnosti. Například typ, který obsahuje metodu s názvem GetColor a vlastnost s názvem Color, způsobit porušení pravidla. Toto pravidlo se neaktivuje, pokud je vlastnost nebo metoda označena pomocí ObsoleteAttribute.

Ve výchozím nastavení toto pravidlo sleduje pouze externě viditelné členy a vlastnosti, ale dá se konfigurovat.

Popis pravidla

Metody „Get“ a vlastnosti by měly mít názvy, které zřetelně rozliší jejich funkce.

Konvence vytváření názvů poskytují společný vzhled knihoven, které cílí na modul CLR (Common Language Runtime). Tato konzistence zkracuje dobu potřebnou k získání nové softwarové knihovny a zvyšuje důvěru zákazníků, že knihovnu vyvinul někdo, kdo má zkušenosti s vývojem spravovaného kódu.

Jak opravit porušení

Změňte název tak, aby se neshodoval s názvem metody, která má předponu Get.

Kdy potlačit upozornění

Nepotlačujte upozornění na toto pravidlo. Jednou z výjimek tohoto pravidla je, pokud je metoda Get způsobená implementací IExtenderProvider rozhraní.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

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

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.

Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (pojmenování), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

Zahrnutí konkrétních povrchů rozhraní API

Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Příklad

Následující příklad obsahuje metodu a vlastnost, které porušují toto pravidlo.

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