CA1711: Gli identificatori non devono contenere un suffisso non corretto
TypeName |
IdentifiersShouldNotHaveIncorrectSuffix |
CheckId |
CA1711 |
Category |
Microsoft.Naming |
Breaking Change |
Breaking |
Causa
Un identificatore contiene un suffisso non corretto.
Descrizione della regola
Per convenzione, solo i nomi di tipi che estendono determinati tipi di base o che implementano determinate interfacce o i tipi derivati da questi tipi devono terminare con suffissi specifici riservati. Gli altri nomi di tipi non devono utilizzare questi suffissi riservati.
Nella tabella riportata di seguito sono elencati i suffissi riservati e i tipi di base e le interfacce a cui sono associati.
Suffisso |
Tipo di base/Interfaccia |
|---|---|
Attribute |
|
Collection |
System.Collections.ICollection System.Collections.IEnumerable |
Dictionary |
|
EventArgs |
|
EventHandler |
Delegato del gestore eventi |
Eccezione |
|
Autorizzazione |
|
Queue |
|
Stack |
|
Stream |
Inoltre, non devono essere utilizzati i seguenti suffissi:
Delegate
Enum
Impl - Utilizzare in alternativa "Core"
Ex o suffisso analogo per distinguerlo da una versione precedente dello stesso tipo
Le convenzioni di denominazione forniscono un aspetto comune alle librerie che si avvalgono di Common Language Runtime. In questo modo si riduce la curva di apprendimento necessaria per le nuove librerie software e i clienti possono confidare nel fatto che la libreria è stata sviluppata da un esperto nello sviluppo di codice gestito.
Come correggere le violazioni
Rimuovere il suffisso dal nome del tipo.
Esclusione di avvisi
Non escludere un avviso da questa regola.
Regole correlate
CA1710: Gli identificatori devono contenere il suffisso corretto
Vedere anche
Riferimenti
Linee guida per l'utilizzo degli attributi