Share via

CA1725: Parameternamn ska matcha basdeklarationen

  • Artikel
Property Värde
Regel-ID CA1725
Rubrik Parameternamnen ska matcha basdeklarationen
Kategori Namngivning
Korrigeringen är icke-bakåtkompatibel Bryta
Aktiverad som standard i .NET 8 Nej

Orsak

Namnet på en parameter i en åsidosättning av en metod matchar inte namnet på parametern i metodens basdeklaration eller namnet på parametern i metodens gränssnittsdeklaration.

Som standard tittar den här regeln bara på externt synliga metoder, men det kan konfigureras.

Regelbeskrivning

Konsekvent namngivning av parametrar i en åsidosättningshierarki ökar användbarheten för metodens åsidosättningar. Ett parameternamn i en härledd metod som skiljer sig från namnet i basdeklarationen kan orsaka förvirring om metoden är en åsidosättning av basmetoden eller en ny överbelastning av metoden.

Så här åtgärdar du överträdelser

Om du vill åtgärda ett brott mot den här regeln byter du namn på parametern så att den matchar basdeklarationen. Korrigeringen är en icke-bakåtkompatibel ändring för COM-synliga metoder.

När du ska ignorera varningar

Utelämna inte en varning från den här regeln förutom com-synliga metoder i bibliotek som tidigare har levererats.

Ignorera en varning

Om du bara vill förhindra en enda överträdelse lägger du till förprocessordirektiv i källfilen för att inaktivera och aktiverar sedan regeln igen.

#pragma warning disable CA1725
// The code that's violating the rule is on this line.
#pragma warning restore CA1725

Om du vill inaktivera regeln för en fil, mapp eller ett projekt anger du dess allvarlighetsgrad till none i konfigurationsfilen.

[*.{cs,vb}]
dotnet_diagnostic.CA1725.severity = none

Mer information finns i Så här utelämnar du kodanalysvarningar.

Konfigurera kod för analys

Använd följande alternativ för att konfigurera vilka delar av kodbasen som regeln ska köras på.

Du kan konfigurera det här alternativet för bara den här regeln, för alla regler som den gäller för eller för alla regler i den här kategorin (namngivning) som den gäller för. Mer information finns i Konfigurationsalternativ för kodkvalitetsregel.

Inkludera specifika API-ytor

Du kan konfigurera vilka delar av kodbasen som ska köras med den här regeln baserat på deras tillgänglighet. Om du till exempel vill ange att regeln endast ska köras mot den icke-offentliga API-ytan lägger du till följande nyckel/värde-par i en .editorconfig-fil i projektet:

dotnet_code_quality.CAXXXX.api_surface = private, internal