MSTEST0010: ClassInitialize-Methode muss ein gültiges Layout aufweisen
Eigenschaft | Wert |
---|---|
Regel-ID | MSTEST0010 |
Titel | ClassInitialize-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 [ClassInitialize]
gekennzeichnete Methode muss ein gültiges Layout aufweisen.
Regelbeschreibung
Methoden, die mit [ClassInitialize]
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
- darf nicht generisch sein
- sollte einen Parameter vom Typ
TestContext
verwenden - Der Rückgabetyp muss
void
,Task
oderValueTask
sein. InheritanceBehavior.BeforeEachDerivedClass
-Attributparameter sollte angegeben werden, wenn die Klasseabstract
ist.- Der
InheritanceBehavior.BeforeEachDerivedClass
-Attributparameter sollte nicht angegeben werden, wenn die Klassesealed
ist.
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.
- 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
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 MSTEST0010
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0010
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.MSTEST0010.severity = none
Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.