CA1511: Použití pomocné rutiny argumentException
Vlastnost | Hodnota |
---|---|
ID pravidla | CA1511 |
Název | Použití pomocné rutiny vyvolání výjimky ArgumentException |
Kategorie | Udržovatelnost |
Oprava způsobující chybu nebo chybu způsobující chybu | Nepřerušované |
Povoleno ve výchozím nastavení v .NET 8 | Jako návrh |
Příčina
Kód zkontroluje, jestli je null
argument nebo prázdný řetězec, a podmíněně vyvolá ArgumentExceptionvýjimku .
Popis pravidla
Kontroly argumentů mají významný dopad na velikost kódu a často dominují kódu pro malé funkce a setter vlastností. Tyto kontroly brání inliningu a způsobují značné znečištění mezipaměti instrukcemi. Pomocné metody, jako ArgumentException.ThrowIfNullOrEmpty(String, String) jsou jednodušší a efektivnější než if
bloky, které vytváří novou instanci výjimky.
Příklad
Následující fragment kódu ukazuje porušení ca1511:
void M(string arg)
{
if (string.IsNullOrEmpty(arg))
throw new ArgumentException("", "arg");
}
Následující fragment kódu ukazuje opravu:
void M(string arg)
{
ArgumentException.ThrowIfNullOrEmpty(arg);
}
Jak opravit porušení
if
Nahraďte blok, který vyvolá výjimku voláním ArgumentException.ThrowIfNullOrEmpty(String, String). Nebo v sadě Visual Studio pomocí nabídky žárovky opravte kód automaticky.
Kdy potlačit upozornění
Pokud vás nezajímá udržovatelnost kódu, je bezpečné potlačit porušení tohoto pravidla. Je také v pořádku potlačit porušení, která jsou identifikována jako falešně pozitivní.
Potlačení upozornění
Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.
#pragma warning disable CA1511
// The code that's violating the rule is on this line.
#pragma warning restore CA1511
Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none
konfiguračním souboru.
[*.{cs,vb}]
dotnet_diagnostic.CA1511.severity = none
Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.