CA1716: Gli identificatori non devono corrispondere a parole chiave

  • Articolo
Proprietà valore
ID regola CA1716
Titolo Gli identificatori non devono corrispondere a parole chiave
Categoria Denominazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Il nome di uno spazio dei nomi, un tipo o un membro di interfaccia o virtuale corrisponde a una parola chiave riservata in un linguaggio di programmazione.

Per impostazione predefinita, questa regola esamina solo spazi dei nomi, tipi e membri visibili esternamente, ma è possibile configurare i tipi di visibilità e simboli.

Descrizione regola

Gli identificatori per spazi dei nomi, tipi e membri di interfaccia e virtuali non devono corrispondere alle parole chiave definite dai linguaggi destinati a Common Language Runtime. A seconda del linguaggio usato e della parola chiave , gli errori e le ambiguità del compilatore possono rendere difficile l'uso della libreria.

Questa regola controlla le parole chiave nelle lingue seguenti:

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

Il confronto senza distinzione tra maiuscole e minuscole viene usato per le parole chiave di Visual Basic e viene usato un confronto con distinzione tra maiuscole e minuscole per gli altri linguaggi.

Come correggere le violazioni

Selezionare un nome che non viene visualizzato nell'elenco delle parole chiave.

Quando eliminare gli avvisi

È possibile eliminare un avviso da questa regola se si è certi che l'identificatore non confonda gli utenti dell'API e che la libreria sia utilizzabile in tutti i linguaggi disponibili in .NET.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare le opzioni seguenti per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare queste opzioni solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (denominazione) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Tipi di simboli analizzati

È possibile configurare i tipi di simboli che verranno analizzati da questa regola. I valori consentiti sono:

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

Separare più valori con una virgola (,). Il valore predefinito include tutti i tipi di simboli nell'elenco precedente.

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