CA1711: os identificadores não devem ter sufixo incorreto
TypeName |
IdentifiersShouldNotHaveIncorrectSuffix |
CheckId |
CA1711 |
Categoria |
Microsoft.Naming |
Alteração Significativa |
Quebra |
Causa
Um identificador tem um sufixo incorreto.
Descrição da Regra
Por convenção, somente os nomes dos tipos que estendem determinados tipos de base ou que implementam determinadas interfaces, ou tipos derivados desses tipos, deve terminar com sufixos específicos reservados.Outros nomes de tipo não devem usar esses sufixos reservadas.
A tabela a seguir lista os sufixos reservadas e os tipos de base e interfaces com associados.
Sufixo |
Tipo de base/interface |
---|---|
Atributo |
|
Coleção |
|
Dicionário |
|
EventArgs |
|
EventHandler |
Um representante do manipulador de eventos |
Exceção |
|
Permissão |
|
Fila |
|
Pilha |
|
Fluxo |
Além disso, os seguintes sufixos se não é usado:
Delegate
Enum
Executa - use “core” em vez
O sufixo ex ou semelhante para distingui-lo de uma versão anterior do mesmo tipo
Convenções de nomenclatura dão uma aparência comum para bibliotecas que tem como foco o common language runtime.Isto reduz a curva de aprendizado que é necessária para novas bibliotecas de software, e aumenta confiança dos clientes de que a biblioteca foi desenvolvida por alguém que com experiência programar código gerenciado.
Como Corrigir Violações
Remova o sufixo do nome do tipo.
Quando Suprimir Alertas
Não suprima um aviso desta regra a menos que o sufixo tem um significado inequívoco no domínio de aplicativo.
Regras Relacionadas
CA1710: os identificadores devem ter o sufixo correto