Sdílet prostřednictvím

CA1801: Zkontrolujte nepoužité parametry

  • Článek
Vlastnost Hodnota
ID pravidla CA1801
Název Zkontrolujte nepoužité parametry
Kategorie Využití
Oprava způsobující chybu nebo chybu způsobující chybu Nerozbití – Pokud není člen viditelný mimo sestavení, bez ohledu na změnu, kterou provedete.

Non-breaking - Pokud změníte člen tak, aby používal parametr v jeho těle.

Přerušení – Pokud odeberete parametr a je viditelný mimo sestavení.
Povoleno ve výchozím nastavení v .NET 9 No

Příčina

Podpis metody obsahuje parametr, který se v těle metody nepoužívá.

Toto pravidlo nezkoumá následující typy metod:

  • Metody odkazované delegátem

  • Metody používané jako obslužné rutiny událostí

  • Konstruktory serializace (viz pokyny).

  • Metody serializace GetObjectData .

  • Metody deklarované pomocí modifikátoru abstract (MustOverride v jazyce Visual Basic).

  • Metody deklarované pomocí modifikátoru virtual (Overridable v jazyce Visual Basic).

  • Metody deklarované pomocí modifikátoru override (Overrides v jazyce Visual Basic).

  • Metody deklarované pomocí modifikátoru extern (Declare příkaz v jazyce Visual Basic)

Toto pravidlo neoznačí parametry, které jsou pojmenovány symbolem zahození , _například , _1a _2. To snižuje šum upozornění na parametry, které jsou potřeba pro požadavky na podpis, například metodu použitou jako delegát, parametr se speciálními atributy nebo parametr, jehož hodnota je implicitně přístupná v době běhu rozhraním, ale není odkazována v kódu.

Poznámka:

Toto pravidlo bylo ve prospěch IDE0060 zastaralé. Informace o tom, jak vynutit analyzátor IDE0060 při sestavení, najdete v analýze stylu kódu.

Popis pravidla

Zkontrolujte parametry v jiných než virtuálních metodách, které se v těle metody nepoužívají, a ujistěte se, že neexistuje nesprávnost, pokud k nim nemáte přístup. Za nevyužité parametry se účtují náklady na údržbu a výkon.

Někdy může porušení tohoto pravidla odkazovat na chybu implementace v metodě. Například parametr by měl být použit v těle metody. Potlačit upozornění tohoto pravidla, pokud parametr musí existovat kvůli zpětné kompatibilitě.

Jak opravit porušení

Chcete-li opravit porušení tohoto pravidla, odeberte nepoužívaný parametr (zásadní změna) nebo použijte parametr v těle metody (změna způsobující chybu).

Kdy potlačit upozornění

Upozornění z tohoto pravidla je bezpečné potlačit:

  • V dříve odeslaném kódu, pro který by oprava byla zásadní změnou.

  • this Pro parametr ve vlastní rozšiřující metodě pro Microsoft.VisualStudio.TestTools.UnitTesting.Assert. Funkce ve Assert třídě jsou statické, takže není nutné přistupovat k parametru this v těle metody.

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 CA1801
// The code that's violating the rule is on this line.
#pragma warning restore CA1801

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.CA1801.severity = none

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.

Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (Výkon), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

Zahrnutí konkrétních povrchů rozhraní API

Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Ve výchozím nastavení se pravidlo CA1801 vztahuje na všechny plochy rozhraní API (veřejné, interní a soukromé).

Příklad

Následující příklad ukazuje dvě metody. Jedna metoda porušuje pravidlo a druhá metoda pravidlo splňuje.

// This method violates the rule.
public static string GetSomething(int first, int second)
{
    return first.ToString(CultureInfo.InvariantCulture);
}

// This method satisfies the rule.
public static string GetSomethingElse(int first)
{
    return first.ToString(CultureInfo.InvariantCulture);
}