CA1725: Nazwy parametrów powinny pasować do podstawowej deklaracji
| Właściwości | Wartość |
|---|---|
| Identyfikator reguły | CA1725 |
| Tytuł | Nazwy parametrów powinny być zgodne z deklaracją podstawową |
| Kategoria | Nazewnictwo |
| Poprawka powodująca niezgodność lub niezgodność | Kluczowa |
| Domyślnie włączone na platformie .NET 9 | Nie. |
Przyczyna
Nazwa parametru w zastąpieniu metody nie jest zgodna z nazwą parametru w deklaracji podstawowej metody lub nazwy parametru w deklaracji interfejsu metody.
Domyślnie ta reguła analizuje tylko metody widoczne zewnętrznie, ale jest to możliwe do skonfigurowania.
Opis reguły
Spójne nazywanie parametrów w zastąpieniu hierarchii zwiększa użyteczność zastąpienia metody. Jeśli nazwa parametru w metodzie pochodnej różni się od nazwy podstawowej deklaracji, może nie być jasne, czy metoda jest zastąpieniem metody podstawowej, czy też nowym przeciążeniem metody.
Jak naprawić naruszenia
Aby naprawić naruszenie tej reguły, zmień nazwę parametru, aby był zgodny z deklaracją podstawową. Poprawka to zmiana powodująca niezgodność dla metod widocznych dla modelu COM.
Kiedy pomijać ostrzeżenia
Nie pomijaj ostrzeżenia z tej reguły z wyjątkiem metod widocznych dla modelu COM w bibliotekach, które zostały wcześniej wysłane.
Pomijanie ostrzeżenia
Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.
#pragma warning disable CA1725
// The code that's violating the rule is on this line.
#pragma warning restore CA1725
Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.
[*.{cs,vb}]
dotnet_diagnostic.CA1725.severity = none
Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.
Konfigurowanie kodu do analizowania
Użyj następującej opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.
Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (nazewnictwo), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.
Uwzględnij określone powierzchnie interfejsu API
Możesz skonfigurować, na których częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:
dotnet_code_quality.CAXXXX.api_surface = private, internal
