CA1720: Gli identificatori non devono contenere nomi di tipo

  • Articolo
Proprietà valore
ID regola CA1720
Titolo Gli identificatori non devono contenere nomi di tipo
Categoria Denominazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Il nome di un parametro in un membro contiene un nome di tipo di dati.

oppure

Il nome di un membro contiene un nome di tipo di dati specifico della lingua.

Per impostazione predefinita, questa regola esamina solo i membri visibili esternamente, ma è configurabile.

Descrizione regola

I nomi dei parametri e dei membri sono meglio usati per comunicare il loro significato che per descrivere il tipo, che dovrebbe essere fornito dagli strumenti di sviluppo. Per i nomi dei membri, se è necessario usare un nome di tipo di dati, usare un nome indipendente dalla lingua anziché un nome specifico della lingua. Ad esempio, anziché il nome intdel tipo C#, usare il nome del tipo di dati indipendente dal linguaggio, Int32.

Ogni token discreto nel nome del parametro o del membro viene controllato in base ai nomi dei tipi di dati specifici della lingua seguenti in modo senza distinzione tra maiuscole e minuscole:

  • Bool
  • WChar
  • Int8
  • UInt8
  • Short
  • UShort
  • Int
  • Uint
  • Intero
  • UInteger
  • Lungo
  • ULong
  • Senza segno
  • Con segno
  • Mobile
  • Float32
  • Float64

Inoltre, i nomi di un parametro vengono controllati anche con i nomi dei tipi di dati indipendenti dalla lingua seguenti in modo senza distinzione tra maiuscole e minuscole:

  • Oggetto
  • Boolean
  • Char
  • Stringa
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • Puntatore
  • UInptr
  • UPtr
  • UPointer
  • Singola
  • Double
  • Decimale
  • GUID

Come correggere le violazioni

Se attivato in base a un parametro:

Sostituire l'identificatore del tipo di dati nel nome del parametro con un termine che ne descrive meglio il significato o un termine più generico, ad esempio "value".

Se attivato contro un membro:

Sostituire l'identificatore del tipo di dati specifico della lingua nel nome del membro con un termine che ne descrive meglio il significato, un equivalente indipendente dalla lingua o un termine più generico, ad esempio "value".

Quando eliminare gli avvisi

L'uso occasionale dei nomi di parametri e membri basati sui tipi potrebbe essere appropriato. Tuttavia, per il nuovo sviluppo, non si verificano scenari noti in cui è consigliabile eliminare un avviso da questa regola. Per le librerie fornite in precedenza, potrebbe essere necessario eliminare un avviso da questa regola.

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

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.CA1720.severity = none

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

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare questa opzione 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