Udostępnij za pośrednictwem

CA1041: Dodaj komunikat atrybutu ObsoleteAttribute

Właściwości Wartość
Identyfikator reguły CA1041
Tytuł Udostępnij komunikat ObsoleteAttribute
Kategoria Projektowanie
Poprawka jest powodująca problemy lub niepowodująca problemów Niezgodność
Domyślnie włączone na platformie .NET 10 Jako sugestia
Zastosowane języki C# i Visual Basic

Przyczyna

Typ lub element członkowski jest oznaczony za pomocą atrybutu System.ObsoleteAttribute , który nie ma określonej właściwości System.ObsoleteAttribute.Message .

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

Opis reguły

ObsoleteAttribute służy do oznaczania przestarzałych typów i elementów biblioteki. Konsumenci biblioteki powinni unikać używania dowolnego typu lub członu oznaczonego jako przestarzałego. Jest to spowodowane tym, że może nie być obsługiwane i ostatecznie zostanie usunięte z nowszych wersji biblioteki. Gdy typ lub element członkowski oznaczony za pomocą ObsoleteAttribute jest kompilowany, właściwość atrybutu Message jest wyświetlana. Dostarcza to użytkownikowi informacji o przestarzałym typie lub elemencie. Ta informacja zazwyczaj obejmuje, jak długo przestarzały typ lub składnik będzie obsługiwany przez projektantów biblioteki i preferowany zamiennik do użycia.

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, dodaj message parametr do konstruktora ObsoleteAttribute .

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżenia z tej reguły, ponieważ Message właściwość udostępnia krytyczne informacje o przestarzałym typie lub elemencie członkowskim.

Konfigurowanie kodu do analizowania

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

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 pokazano przestarzały element członkowski z poprawnie zadeklarowanym elementem ObsoleteAttribute.

[ObsoleteAttribute("This property is obsolete and will be removed in a " +
"future version. Use the FullName property instead.", false)]
public string Name
{
    get => "Name";
}

Imports System

Namespace ca1041

    Public Class ObsoleteAttributeOnMember

        <ObsoleteAttribute("This property is obsolete and will " &
             "be removed in a future version. Use the FirstName " &
             "and LastName properties instead.", False)>
        ReadOnly Property Name As String
            Get
                Return "Name"
            End Get
        End Property

        ReadOnly Property FirstName As String
            Get
                Return "FirstName"
            End Get
        End Property

        ReadOnly Property LastName As String
            Get
                Return "LastName"
            End Get
        End Property

    End Class

End Namespace

Zobacz też

  • Last updated on