Udostępnij za pośrednictwem


CA1047: Nie deklaruj chronionych członków w typach zapieczętowanych

Właściwości Wartość
Identyfikator reguły CA1047
Tytuł Nie deklaruj chronionych składowych w typach zapieczętowanych
Kategoria Projektowanie
Poprawka łamiąca lub nienaruszająca Niezgodność
Domyślnie włączone na platformie .NET 10 Jako sugestia
Zastosowane języki C# i Visual Basic

Przyczyna

Typ publiczny to sealed (NotInheritable w Visual Basic) i deklaruje chroniony element członkowski lub chroniony typ zagnieżdżony. Ta reguła nie zgłasza naruszeń dotyczących metod Finalize, które muszą być zgodne z tym wzorcem.

Opis reguły

Chronione elementy członkowskie są zadeklarowane w typach tak, aby typy dziedziczące miały dostęp do elementu członkowskiego i mogły go zastąpić. Z definicji nie można dziedziczyć typu zapieczętowanego, co oznacza, że metody chronione w typach zapieczętowanych nie mogą być wywoływane.

Kompilator języka C# emituje ostrzeżenie CS0628 zamiast CA1047 w tej sytuacji.

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, zmień poziom dostępu członka na prywatny lub spraw, aby typ był dziedziczony.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dla tej reguły. Pozostawienie typu w bieżącym stanie może powodować problemy z konserwacją i nie zapewnia żadnych korzyści.

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 typ naruszający tę regułę.

public sealed class SealedClass
{
    protected void ProtectedMethod(){}
}
Public NotInheritable Class BadSealedType
    Protected  Sub MyMethod
    End Sub
End Class