Udostępnij za pośrednictwem

CA1707: Identyfikatory nie powinny zawierać podkreśleń

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA1707
Stanowisko Identyfikatory nie powinny zawierać znaków podkreślenia
Kategoria Nazewnictwo
Poprawka powodująca niezgodność lub niezgodność Przerywanie — w przypadku podniesionych zestawów

Niezgodność — w przypadku zgłoszenia parametrów typu
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Nazwa identyfikatora zawiera znak podkreślenia (_).

Opis reguły

Przez konwencję identyfikatory nazw nie zawierają znaku podkreślenia (_). Reguła sprawdza przestrzenie nazw, typy, elementy członkowskie i parametry.

Konwencje nazewnictwa zapewniają wspólny wygląd bibliotek przeznaczonych dla środowiska uruchomieniowego języka wspólnego. Zmniejsza to krzywą uczenia wymaganą dla nowych bibliotek oprogramowania i zwiększa pewność klienta, że biblioteka została opracowana przez kogoś, kto ma doświadczenie w tworzeniu kodu zarządzanego.

Jak naprawić naruszenia

Usuń wszystkie znaki podkreślenia z nazwy.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dotyczących kodu produkcyjnego. Można jednak bezpiecznie pominąć to ostrzeżenie dla kodu testowego.

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

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

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

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.

W przypadku dobrze znanych metod w kodzie firmy Microsoft, które obecnie używają podkreślenia i nie można ich modyfikować, reguła powinna zostać pominięta.

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