CA1721: Nazwy właściwości nie powinny odpowiadać metodom Get

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA1721
Stanowisko Nazwy właściwości nie powinny być takie same jak nazwy metod Get
Kategoria Nazewnictwo
Poprawka powodująca niezgodność lub niezgodność Kluczowa
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Nazwa elementu członkowskiego zaczyna się od "Get" i w przeciwnym razie pasuje do nazwy właściwości. Na przykład typ zawierający metodę o nazwie "GetColor" i właściwość o nazwie "Color" powodują naruszenie reguły. Ta reguła nie zostanie wyzwolona, jeśli właściwość lub metoda zostanie oznaczona znakiem ObsoleteAttribute.

Domyślnie ta reguła sprawdza tylko widoczne zewnętrznie elementy członkowskie i właściwości, ale jest to możliwe do skonfigurowania.

Opis reguły

Metody „Get” i właściwości powinny mieć nazwy, które wyraźnie odróżniają ich funkcje.

Konwencje nazewnictwa zapewniają wspólny wygląd bibliotek przeznaczonych dla środowiska uruchomieniowego języka wspólnego. Ta spójność skraca czas wymagany do nauki nowej biblioteki oprogramowania i zwiększa pewność klienta, że biblioteka została opracowana przez kogoś, kto ma doświadczenie w tworzeniu kodu zarządzanego.

Jak naprawić naruszenia

Zmień nazwę tak, aby nie była zgodna z nazwą metody poprzedzonej prefiksem "Get".

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dla tej reguły. Jednym wyjątkiem od tej reguły jest to, że metoda "Get" jest spowodowana implementacją interfejsu IExtenderProvider .

Pomijanie ostrzeżenia

Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

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

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

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

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (nazewnictwo), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Uwzględnij określone powierzchnie interfejsu API

Możesz skonfigurować, na których częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Przykład

Poniższy przykład zawiera metodę i właściwość naruszającą tę regułę.

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