CA1511: Use ArgumentException throw helper
Tulajdonság | Érték |
---|---|
Szabályazonosító | CA1511 |
Cím | Az ArgumentException dobás segéd használata |
Kategória | Fenntarthatóság |
A javítás kompatibilitástörő vagy nem törik | Nem törés |
Alapértelmezés szerint engedélyezve a .NET 8-ban | Javaslatként |
Ok
A kód ellenőrzi, hogy egy argumentum vagy egy üres sztring, null
majd feltételesen ArgumentExceptionegy .
Szabály leírása
Az argumentum-ellenőrzések jelentős hatással vannak a kód méretére, és gyakran uralják a kis függvények és a tulajdonsághalmazok kódját. Ezek az ellenőrzések megakadályozzák a címkézést, és jelentős utasítás-gyorsítótár-szennyezést okoznak. A dobássegítő módszerek, például ArgumentException.ThrowIfNullOrEmpty(String, String) egyszerűbbek és hatékonyabbak, mint if
az új kivételpéldányt építő blokkok.
Példa
A következő kódrészlet a CA1511 megsértése esetén jelenik meg:
void M(string arg)
{
if (string.IsNullOrEmpty(arg))
throw new ArgumentException("", "arg");
}
A következő kódrészlet a javítást mutatja:
void M(string arg)
{
ArgumentException.ThrowIfNullOrEmpty(arg);
}
Szabálysértések kijavítása
Cserélje le a if
kivételt okozó blokkot egy hívásra ArgumentException.ThrowIfNullOrEmpty(String, String). Vagy a Visual Studióban a villanykörte menü használatával automatikusan kijavíthatja a kódot.
Mikor kell letiltani a figyelmeztetéseket?
Ha nem aggódik a kód karbantarthatósága miatt, nyugodtan letilthatja a szabály megsértését. Az is jó, ha elnyomja a hamis pozitívnak minősített szabálysértéseket.
Figyelmeztetés mellőzése
Ha csak egyetlen szabálysértést szeretne letiltani, adjon hozzá előfeldolgozási irányelveket a forrásfájlhoz a szabály letiltásához és újbóli engedélyezéséhez.
#pragma warning disable CA1511
// The code that's violating the rule is on this line.
#pragma warning restore CA1511
Ha le szeretné tiltani egy fájl, mappa vagy projekt szabályát, állítsa annak súlyosságát none
a konfigurációs fájlban.
[*.{cs,vb}]
dotnet_diagnostic.CA1511.severity = none
További információ: Kódelemzési figyelmeztetések letiltása.