Sdílet prostřednictvím


MSTEST0025: Místo vždy selhávajícího výrazu použijte Assert.Fail.

Vlastnost Hodnota
ID pravidla MSTEST0025
Název Místo vždy selhávajícího kontrolního výrazu použijte Assert.Fail.
Kategorie Návrh
Oprava způsobující chybu nebo chybu způsobující chybu Nenarušující
Povoleno ve výchozím nastavení Ano
Výchozí závažnost Informace
Představeno ve verzi 3.4.0
Existuje oprava kódu. Ano

Příčina

Toto pravidlo vyvolá diagnostiku, když volání kontrolního výrazu vytvoří podmínku always-false.

Popis pravidla

Použití Assert.Fail přes vždy selhávající volání kontrolního výrazu poskytuje jasnější záměr a lepší dokumentaci pro kód.

Když narazíte na kontrolní výraz, který vždy selže (například), nemusí být okamžitě zřejmé, Assert.IsTrue(false)že někdo čte kód, proč kontrolní výraz existuje nebo jaký stav se pokouší zkontrolovat. To může vést k nejasnostem a plýtvání časem pro vývojáře, kteří se s kódem setkali později.

Použití Assert.Fail naproti tomu umožňuje zadat vlastní zprávu o selhání, aby bylo jasné, proč kontrolní výraz selhává a jaká konkrétní podmínka nebo scénář řeší. Tato zpráva slouží jako dokumentace k záměru kontrolního výrazu a pomáhá ostatním vývojářům porozumět účelu kontrolního výrazu, aniž by se museli podrobně zabývat kódem.

Použití Assert.Fail celkově podporuje přehlednost, dokumentaci a udržovatelnost v základu kódu, takže je lepší volbou pro vždy neúspěšné volání kontrolního výrazu.

Jak opravit porušení

Ujistěte se, že volání , Assert.IsTrue, Assert.IsFalseAssert.AreEqual, Assert.AreNotEqualAssert.IsNull nebo Assert.IsNotNull nevytvájí vždy selhávající podmínky.

Kdy potlačit upozornění

Nedoporučujeme potlačit upozornění z tohoto pravidla.