Teilen über

CA1852: Versiegeln interner Typen

  • Artikel
Eigenschaft Wert
Regel-ID CA1852
Titel Interne Typen versiegeln
Kategorie Leistung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Eingeführt in Version .NET 7
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein Typ, auf den außerhalb der Assembly nicht zugegriffen werden kann und der keine Untertypen innerhalb der enthaltenden Assembly besitzt, ist nicht als sealed markiert (in Visual Basic NotInheritable).

Regelbeschreibung

Wenn auf einen Typ nicht außerhalb seiner Assembly zugegriffen werden kann und er keine Untertypen innerhalb seiner enthaltenden Assembly aufweist, kann dieser gefahrlos versiegelt werden. Die Versiegelung von Typen kann die Leistung verbessern.

Wenn Sie System.Runtime.CompilerServices.InternalsVisibleToAttribute auf die zu analysierende Assembly anwenden, kennzeichnet diese Regel keine Typen, die standardmäßig nicht als sealed gekennzeichnet sind, da ein Feld von einer Friend-Assembly verwendet werden kann. Wenn Sie die Assembly trotzdem analysieren möchten, finden Sie weitere Informationen unter Konfigurieren von zu analysierendem Code.

Behandeln von Verstößen

Markieren Sie den Typ als sealed (in Visual Basic NotInheritable).

Beispiel

Der folgende Codeausschnitt zeigt eine Verletzung von CA1852:

internal class C
{ }

Class C
End Class

Der folgende Codeausschnitt korrigiert die Verletzung:

internal sealed class C
{ }

NotInheritable Class C
End Class

Wann sollten Warnungen unterdrückt werden?

Es ist ungefährlich, eine Warnung zu unterdrücken, wenn die Leistung kein Problem ist.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Konfigurieren des zu analysierenden Codes

Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Option nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Leistung) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Ignorieren des InternalsVisibleTo-Attribut

Standardmäßig ist diese Regel deaktiviert, wenn die zu analysierende Assembly InternalsVisibleToAttribute verwendet, um ihre internen Symbole verfügbar zu machen. Um festzulegen, dass die Regel auch dann ausgeführt werden soll, wenn die Assembly mit InternalsVisibleToAttribute gekennzeichnet ist, fügen Sie das folgende Schlüssel-Wert-Paar einer EDITORCONFIG-Datei in Ihrem Projekt hinzu:

dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true

Diese Option ist ab .NET 8 verfügbar.