MSTEST0021: Föredrar att kasta framför TestCleanup-metoder
Property | Värde |
---|---|
Regel-ID | MSTEST0021 |
Title | Föredrar att göra sig av med TestCleanup-metoder |
Kategori | Designa |
Korrigeringen är icke-bakåtkompatibel | Icke-icke-bryta |
Aktiverad som standard | Nej |
Standard allvarlighetsgrad | Info |
Introducerad i version | 3.4.0 |
Finns det en kodkorrigering | Ja, från och med 3.7.0 |
Orsak
Den här regeln genererar en diagnostik när det finns en void-metod [TestCleanup]
eller någon [TestCleanup]
om det riktade ramverket stöder IAsyncDisposable
gränssnitt.
Regelbeskrivning
Att använda Dispose
eller DisposeAsync
är ett vanligare mönster och vissa utvecklare föredrar att alltid använda det här mönstret även för tester.
Så här åtgärdar du överträdelser
Ersätt [TestCleanup]
metoden med Dispose
eller DisposeAsync
mönstret.
När du ska ignorera varningar
Du vill vanligtvis inte ignorera varningar från den här regeln om du har valt att anmäla dig för den.
Anmärkning
Den här regeln är frivillig. Det är inte aktiverat även när du använder <MSTestAnalysisMode>All</MSTestAnalysisMode>
. För mer information om MSTestAnalysisMode
, se MSTest kodanalys.
Ignorera en varning
Om du bara vill förhindra en enda överträdelse lägger du till förprocessordirektiv i källfilen för att inaktivera och aktiverar sedan regeln igen.
#pragma warning disable MSTEST0021
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0021
Om du vill inaktivera regeln för en fil, mapp eller ett projekt anger du dess allvarlighetsgrad till none
i konfigurationsfilen.
[*.{cs,vb}]
dotnet_diagnostic.MSTEST0021.severity = none
Mer information finns i Så här utelämnar du kodanalysvarningar.