Partilhar via


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 os sufixos específicos de reservado. Outros nomes de tipo não devem usar esses sufixos reservados.

A tabela a seguir lista os sufixos reservados e tipos base e interfaces que eles estão associados.

Sufixo

Interface/tipo de base

Atributo

System.Attribute

Coleção

System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable

Dicionário

System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey, TValue>

EventArgs

System.EventArgs

EventHandler

Um delegado manipulador de eventos

Exceção

System.Exception

Permissão

System.Security.IPermission

Fila

System.Collections.Queue

Pilha

System.Collections.Stack

Fluxo

System.IO.Stream

Além disso, os seguintes sufixos devem não ser usado:

  • Delegado

  • Enum

  • Implementação - use 'Core' em vez disso

  • 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

Consulte também

Referência

Diretrizes de uso do atributo

Conceitos

Eventos e representantes