CA1044: Właściwości nie powinny być tylko do zapisu

Właściwości	Wartość
Identyfikator reguły	CA1044
Tytuł	Właściwości nie powinny być wyłącznie do zapisu
Kategoria	Projektowanie
Poprawka łamiąca lub nienaruszająca	Przełomowe
Domyślnie włączone na platformie .NET 10	Nie.
Zastosowane języki	C# i Visual Basic

Przyczyna

Właściwość ma ustawioną metodę dostępu, ale nie metodę dostępu.

Domyślnie ta reguła analizuje tylko typy widoczne zewnętrznie, ale można to skonfigurować.

Opis reguły

Metody dostępowe uzyskują dostęp do odczytu właściwości, a metody ustawiające zapewniają dostęp do zapisu. Chociaż posiadanie właściwości tylko do odczytu jest dopuszczalne i często konieczne, wytyczne projektowania zabraniają używania właściwości tylko do zapisu. Dzieje się tak, ponieważ umożliwienie użytkownikowi ustawienia wartości, a następnie uniemożliwienie użytkownikowi wyświetlania wartości nie zapewnia żadnych zabezpieczeń. Poza tym bez dostępu do odczytu nie można przeglądać stanu obiektów udostępnionych, co ogranicza ich przydatność.

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, dodaj metodę get dostępu do właściwości. Alternatywnie, jeśli konieczność zachowania właściwości tylko do zapisu zachodzi, rozważ przekształcenie tej właściwości na metodę.

Kiedy pomijać ostrzeżenia

Zaleca się, aby nie pomijać ostrzeżeń z tej reguły.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części kodu mają być objęte tą regułą.

• Uwzględnij określone powierzchnie interfejsu API

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 (Projekt), 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óre części bazy kodu ma być stosowana ta reguła, na podstawie ich poziomu dostępu, ustawiając opcję api_surface. 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

Notatka

Zastąp część XXXXCAXXXX identyfikatorem odpowiedniej reguły.

Przykład

W poniższym przykładzie BadClassWithWriteOnlyProperty jest typem z właściwością tylko do zapisu. GoodClassWithReadWriteProperty zawiera poprawiony kod.

Imports System

Namespace ca1044

    Public Class BadClassWithWriteOnlyProperty

        Dim someName As String

        ' Violates rule PropertiesShouldNotBeWriteOnly.
        WriteOnly Property Name As String
            Set
                someName = Value
            End Set
        End Property

    End Class

    Public Class GoodClassWithReadWriteProperty

        Property Name As String

    End Class

End Namespace

public class BadClassWithWriteOnlyProperty
{
    string? _someName;

    // Violates rule PropertiesShouldNotBeWriteOnly.
    public string? Name
    {
        set
        {
            _someName = value;
        }
    }
}

public class GoodClassWithReadWriteProperty
{
    public string? Name { get; set; }
}