CA1725: Parameternamen moeten overeenkomen met basisdeclaratie
| Eigenschappen | Weergegeven als |
|---|---|
| Regel-id | CA1725 |
| Titel | Parameternamen moeten overeenkomen met basisdeclaratie |
| Categorie | Naamgeving |
| Oplossing is brekend of niet-brekend | Breken |
| Standaard ingeschakeld in .NET 9 | Nee |
Oorzaak
De naam van een parameter in een methodeoverschrijven komt niet overeen met de naam van de parameter in de basisdeclaratie van de methode of de naam van de parameter in de interfacedeclaratie van de methode.
Deze regel kijkt standaard alleen naar extern zichtbare methoden, maar dit is configureerbaar.
Beschrijving van regel
Consistente naamgeving van parameters in een onderdrukkingshiërarchie verhoogt de bruikbaarheid van de methode-onderdrukkingen. Een parameternaam in een afgeleide methode die verschilt van de naam in de basisdeclaratie kan verwarring veroorzaken over het feit of de methode een onderdrukking is van de basismethode of een nieuwe overbelasting van de methode.
Schendingen oplossen
Als u een schending van deze regel wilt oplossen, wijzigt u de naam van de parameter zodat deze overeenkomt met de basisdeclaratie. De oplossing is een belangrijke wijziging voor zichtbare COM-methoden.
Wanneer waarschuwingen onderdrukken
Onderdrukt geen waarschuwing van deze regel, met uitzondering van COM-zichtbare methoden in bibliotheken die eerder zijn verzonden.
Een waarschuwing onderdrukken
Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.
#pragma warning disable CA1725
// The code that's violating the rule is on this line.
#pragma warning restore CA1725
Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.
[*.{cs,vb}]
dotnet_diagnostic.CA1725.severity = none
Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.
Code configureren om te analyseren
Gebruik de volgende optie om te configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd.
U kunt deze optie configureren voor alleen deze regel, voor alle regels waarop deze van toepassing is, of voor alle regels in deze categorie (naamgeving) waarop deze van toepassing is. Zie de configuratieopties voor de codekwaliteitsregel voor meer informatie.
Specifieke API-oppervlakken opnemen
U kunt instellen op welke onderdelen van uw codebase deze regel moet worden uitgevoerd, op basis van hun toegankelijkheid. Als u bijvoorbeeld wilt opgeven dat de regel alleen moet worden uitgevoerd op het niet-openbare API-oppervlak, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:
dotnet_code_quality.CAXXXX.api_surface = private, internal
