Udostępnij za pośrednictwem

CA1716: Identyfikatory nie powinny odpowiadać słowom kluczowym

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA1716
Tytuł Identyfikatory nie powinny być zgodne ze słowami kluczowymi
Kategoria Nazewnictwo
Poprawka powodująca niezgodność lub niezgodność Kluczowa
Domyślnie włączone na platformie .NET 9 Nie.

Przyczyna

Nazwa przestrzeni nazw, typu lub elementu członkowskiego interfejsu jest zgodna z zastrzeżonym słowem kluczowym w języku programowania.

Domyślnie ta reguła analizuje tylko widoczne zewnętrznie przestrzenie nazw, typy i elementy członkowskie, ale można skonfigurować widoczność i rodzaje symboli.

Opis reguły

Identyfikatory przestrzeni nazw, typów i elementów członkowskich interfejsu i wirtualnych nie powinny być zgodne ze słowami kluczowymi zdefiniowanymi przez języki przeznaczone dla środowiska uruchomieniowego języka wspólnego. W zależności od używanego języka i słowa kluczowego błędy i niejednoznaczności kompilatora mogą utrudnić użycie biblioteki.

Ta reguła sprawdza słowa kluczowe w następujących językach:

  • Visual Basic
  • C#
  • C++/CLI

Porównanie bez uwzględniania wielkości liter jest używane dla słów kluczowych języka Visual Basic, a w innych językach jest używane porównanie z uwzględnieniem wielkości liter.

Jak naprawić naruszenia

Wybierz nazwę, która nie jest wyświetlana na liście słów kluczowych.

Kiedy pomijać ostrzeżenia

Możesz pominąć ostrzeżenie z tej reguły, jeśli masz pewność, że identyfikator nie będzie mylić użytkowników interfejsu API i że biblioteka jest dostępna we wszystkich dostępnych językach na platformie .NET.

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

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

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

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

Konfigurowanie kodu do analizowania

Użyj poniższych opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.

Możesz skonfigurować te opcje 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

Przeanalizowane rodzaje symboli

Można skonfigurować rodzaje symboli, które będą analizowane przez tę regułę. Dozwolone wartości to:

  • Namespace
  • NamedType
  • Method
  • Property
  • Event
  • Parameter

Oddzielaj wiele wartości przecinkami (,). Wartość domyślna zawiera wszystkie rodzaje symboli na poprzedniej liście.

dotnet_code_quality.CA1716.analyzed_symbol_kinds = Namespace, NamedType, Method, Property, Event