MSTEST0009: TestCleanup-Methode muss ein gültiges Layout aufweisen
Eigenschaft | Wert |
---|---|
Regel-ID | MSTEST0009 |
Titel | TestCleanup-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 [TestCleanup]
gekennzeichnete Methode muss ein gültiges Layout aufweisen.
Regelbeschreibung
Methoden, die mit [TestCleanup]
gekennzeichnet sind, müssen folgendes Layout aufweisen, um gültig zu sein:
- Dort sollte
public
stehen. - Sie darf nicht auf
abstract
festgelegt sein. - Sie darf nicht auf
async void
festgelegt sein. - Sie darf nicht auf
static
festgelegt sein. - darf keine spezielle Methode (Finalizer, Operator ...) sein
- Sie darf nicht generisch sein.
- Sie darf keinen Parameter akzeptieren.
- Der Rückgabetyp muss
void
,Task
oderValueTask
sein.
Der Typ, der diese Methoden deklariert, sollte außerdem die folgenden Regeln beachten:
- Der Typ sollte eine
class
sein. - Die
class
solltepublic
oderinternal
sein (wenn das Testprojekt das[DiscoverInternals]
-Attribut verwendet). - Die
class
sollte nichtstatic
sein. - Wenn die
class
sealed
ist, sollte sie mit[TestClass]
(oder einem abgeleiteten Attribut) gekennzeichnet werden.
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 MSTEST0009
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0009
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.MSTEST0009.severity = none
Weitere Informationen finden Sie unter So unterdrücken Sie Codeanalysewarnungen.