Freigeben über

MSTEST0011: ClassCleanup-Methode muss ein gültiges Layout aufweisen

  • Artikel
Eigenschaft Wert
Regel-ID MSTEST0011
Titel ClassCleanup-Methode muss ein gültiges Layout aufweisen
Kategorie Verwendung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig aktiviert Ja
Standardschweregrad Warnung
Eingeführt in Version 3.3.0
Gibt es eine Codekorrektur Ja

Ursache

Eine mit [ClassCleanup] gekennzeichnete Methode muss ein gültiges Layout aufweisen.

Regelbeschreibung

Methoden, die mit [ClassCleanup] gekennzeichnet sind, müssen folgendes Layout aufweisen, um gültig zu sein:

  • sie kann nicht für eine generische Klasse deklariert werden, ohne dass der InheritanceBehavior-Modus festgelegt ist
  • muss public sein
  • muss static sein
  • darf nicht async void sein
  • darf keine spezielle Methode (Finalizer, Operator ...) sein
  • Sie darf nicht generisch sein.
  • sollten keine Parameter angenommen werden, oder ab MSTest 3.8 kann ein einzelner TestContext-Parameter verwendet werden.
  • Der Rückgabetyp muss void, Task oder ValueTask sein.
  • InheritanceBehavior.BeforeEachDerivedClass-Attributparameter sollte angegeben werden, wenn die Klasse abstract ist.
  • Der InheritanceBehavior.BeforeEachDerivedClass-Attributparameter sollte nicht angegeben werden, wenn die Klasse sealed ist.

Der Typ, der diese Methoden deklariert, sollte außerdem die folgenden Regeln beachten:

  • Der Typ sollte eine class sein.
  • Die class sollte public oder internal sein (wenn das Testprojekt das [DiscoverInternals]-Attribut verwendet).
  • Die class sollte nicht static sein.
  • Wenn die classsealed ist, sollte sie mit [TestClass] (oder einem abgeleiteten Attribut) gekennzeichnet werden.
  • Die Klasse sollte nicht generisch sein.

Behandeln von Verstößen

Stellen Sie sicher, dass die Methode dem oben beschriebenen Layout entspricht.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie keine Warnung dieser Regel. Wenn Sie diese Regel ignorieren, werden gekennzeichnete Instanzen entweder übersprungen, oder sie führen zu Laufzeitfehlern.

Unterdrücken einer Warnung

Wenn Sie nur eine einzelne Verletzung unterdrücken möchten, fügen Sie Ihrer Quelldatei Präprozessordirektiven hinzu, um die Regel zu deaktivieren und dann erneut zu aktivieren.

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

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

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

Weitere Informationen finden Sie unter So unterdrücken Sie Codeanalysewarnungen.