CA1041: Poskytněte zprávu ObsoleteAttribute

Článek
09/06/2023

Vlastnost	Hodnota
ID pravidla	CA1041
Název	Poskytněte zprávu ObsoleteAttribute
Kategorie	Návrh
Oprava způsobující chybu nebo chybu způsobující chybu	Nenarušující
Povoleno ve výchozím nastavení v .NET 8	Jako návrh

Příčina

Typ nebo člen je označen atributem, který nemá zadanou System.ObsoleteAttribute vlastnost System.ObsoleteAttribute.Message .

Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné typy a členy, ale dá se nakonfigurovat.

Popis pravidla

ObsoleteAttribute slouží k označení zastaralých typů knihoven a členů. Příjemci knihovny by se měli vyhnout použití libovolného typu nebo člena, který je označený jako zastaralý. Důvodem je to, že se nemusí podporovat a nakonec se odebere z novějších verzí knihovny. Při kompilaci typu nebo členu označeného pomocí ObsoleteAttribute se Message zobrazí vlastnost atributu. To uživateli poskytuje informace o zastaralém typu nebo členu. Tyto informace obecně zahrnují, jak dlouho budou návrháři knihoven podporovat zastaralý typ nebo člen a upřednostňovanou náhradu pro použití.

Jak opravit porušení

Chcete-li opravit porušení tohoto pravidla, přidejte message parametr do konstruktoru ObsoleteAttribute .

Kdy potlačit upozornění

Nepotlačujte upozornění z tohoto pravidla, protože Message vlastnost poskytuje důležité informace o zastaralém typu nebo členu.

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.

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

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 (Návrh), 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 ukazuje zastaralý člen, který má správně deklarovaný 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

Viz také

System.ObsoleteAttribute