CA1725: Názvy parametrů by měly odpovídat základní deklaraci

Vlastnost	Hodnota
ID pravidla	CA1725
Název	Názvy parametrů by měly odpovídat základní deklaraci
Kategorie	Pojmenování
Oprava způsobující chybu nebo chybu způsobující chybu	Narušující
Povoleno ve výchozím nastavení v .NET 10	No

Příčina

Název parametru v přepsání metody neodpovídá názvu parametru v základní deklaraci metody nebo názvu parametru v deklaraci rozhraní metody.

Ve výchozím nastavení toto pravidlo sleduje pouze externě viditelné metody, ale dá se konfigurovat.

Popis pravidla

Konzistentní pojmenování parametrů v hierarchii přetěžování zvyšuje použitelnost přetížení metody. Název parametru, který se v odvozené metodě liší od názvu v základní deklaraci, může způsobit zmatení, zda se u metody jedná o přepis základní metody, nebo o nové přetížení metody.

Jak opravit porušení

Chcete-li opravit porušení tohoto pravidla, přejmenujte parametr tak, aby odpovídal základní deklaraci. Oprava je zásadní změna pro volající, kteří zadávají název parametru.

Example

public interface IUserService
{
    int GetAge(int id);
}

public class UserService : IUserService
{
    // Violates CA1725: Parameter name should match the base declaration ('id')
    // for consistency with IUserService
    public int GetAge(int userId)
    {
        throw new NotImplementedException();
    }
}

Kdy potlačit upozornění

Nepotlačujte upozornění z tohoto pravidla s výjimkou viditelných metod v knihovnách, které byly dříve odeslány.

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

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.CA1725.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.

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

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 (pojmenování), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

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

Nastavením možnosti api_surface můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět na základě jejich přístupnosti. 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

Poznámka

Nahraďte XXXX část CAXXXX ID příslušného pravidla.