CA1711: Identificadores não devem ter o sufixo incorreto
TypeName |
IdentifiersShouldNotHaveIncorrectSuffix |
CheckId |
CA1711 |
<strong>Categoria</strong> |
Microsoft.Naming |
Alteração significativa |
Quebrando |
Causa
Um identificador tem um sufixo incorreto.
Descrição da regra
Por convenção, apenas os nomes dos tipos que ampliam a determinados tipos de base ou que implementar determinadas interfaces ou tipos derivados desses tipos, devem terminar com sufixos reservados específicos.Outros nomes de tipo não devem usar esses sufixos reservados.
A tabela a seguir lista os sufixos reservados e os tipos base e interfaces com o qual eles estão associados.
Sufixo |
Interface/tipo de base |
|---|---|
Atributo |
|
Coleção |
System.Collections.ICollection System.Collections.IEnumerable |
Dicionário |
|
EventArgs |
|
EventHandler |
Um delegado manipulador de eventos |
Exceção |
|
Permissão |
|
Fila |
|
Pilha |
|
Fluxo |
Além disso, os seguintes sufixos devem não ser usado:
Delegado
Enum
Implementação - nesse caso, use 'Core'
EX ou sufixo semelhante para distingui-lo de uma versão anterior do mesmo tipo
Convenções de nomenclatura fornecem um aspecto familiar a bibliotecas que se destinam ao uso com a common language runtime.Isso reduz a curva de aprendizado que é necessário para novas bibliotecas de software e aumenta a confiança do cliente que a biblioteca foi desenvolvida por alguém que tenha experiência em desenvolvimento de código gerenciado.
Como corrigir violações
Remova o sufixo do nome do tipo.
Quando suprimir avisos
Não suprimir um aviso da regra.
Regras relacionadas
CA1710: Identificadores devem ter o correto sufixo