Avisos de nomeação.
Nomeação de suporte a conformidade com as convenções de nomeação de avisos a .NET Framework as diretrizes de Design.
Nesta seção
Regra |
Descrição |
---|---|
Esta regra pressupõe que um membro de enumeração tem um nome que contenha "reservado" não está sendo usado, mas é um espaço reservado para ser renomeado ou removido em uma versão futura.Renomear ou remover um membro é uma alteração significativa. |
|
O nome de um evento começa com "Antes" ou "Depois".Para nomear os eventos relacionados que são gerados em uma seqüência específica, use o presente ou o indicativo do passado para indicar a posição relativa na seqüência de ações. |
|
Uma enumeração pública tem o atributo FlagsAttribute e seu nome não termina em "s".Tipos que são marcados com FlagsAttribute têm nomes que estão no plural, porque o atributo indica que mais de um valor pode ser especificado. |
|
O nome de um identificador visível externamente contém uma ou mais palavras que não são reconhecidas pela biblioteca do verificador ortográfico do Microsoft. |
|
Identificadores para namespaces, tipos, membros e parâmetros não não só diferem caso pois linguagens que direcionam o common language runtime não são necessárias para diferenciar maiúsculas de minúsculas. |
|
O nome de uma interface visível externamente não inicia com um "I" maiúsculo.O nome de um parâmetro de tipo genérico em um tipo visível externamente ou método não inicia com "T" maiúsculo. |
|
O nome do parâmetro em um membro visível externamente contém um nome de tipo de dados ou o nome de um membro visível externamente contém um nome de tipo de dados específicos do idioma. |
|
Por convenção, somente determinados elementos de programação têm nomes que começam com um prefixo específico. |
|
Por convenção, apenas os nomes dos tipos que ampliam a determinados tipos de base ou que implementam 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. |
|
CA1717: O enums de FlagsAttribute apenas devem ter nomes no plural |
Convenções de nomenclatura determinam que um nome no plural para uma enumeração indica que mais de um valor da enumeração pode ser especificado ao mesmo tempo. |
CA1725: Nomes de parâmetro devem corresponder à declaração de base |
Nomeação consistente de parâmetros em uma hierarquia de substituição aumenta a usabilidade das substituições de método.Um nome de parâmetro em um método derivado que difere do nome na declaração da base pode causar confusão sobre se o método é uma substituição do método base ou uma nova sobrecarga do método. |
CA1719: Nomes de parâmetro não devem corresponder a nomes de membros |
Um nome de parâmetro deve comunicar o significado de um parâmetro e um nome de membro deve comunicar o significado de um membro.Seria um design raro onde elas eram os mesmos.Nomeando um parâmetro da mesma como seu nome de membro é não intuitivos e dificulta usar a biblioteca. |
CA1701: Palavras compostas de seqüência de caracteres de recurso devem ser minúsculas corretamente |
Cada palavra na seqüência de recurso é dividida em tokens que sejam baseiam as maiúsculas e minúsculas.Cada combinação de token de dois contígua é verificada pela biblioteca do verificador ortográfico do Microsoft.Se reconhecido, a palavra produz uma violação da regra. |
CA1703: Seqüências de recursos devem ser escritas corretamente |
Uma seqüência de recurso contém uma ou mais palavras que não são reconhecidas pela biblioteca do verificador ortográfico do Microsoft. |
Nomes de tipo não devem corresponder os nomes dos namespaces que são definidos na .NET Framework biblioteca de classes.A violação desta regra pode reduzir a capacidade de uso da biblioteca. |
|
Por convenção, nomes de identificador não contêm o caractere de sublinhado (_).Esta regra verifica namespaces, tipos, membros e parâmetros. |
|
CA1721: Métodos de obter propriedade nomes não devem corresponder. |
O nome de um membro público ou protegido começa com "Get" e outra forma corresponde ao nome de uma propriedade pública ou protegida. "Propriedades e métodos get"devem ter nomes que distinguir claramente suas funções. |
CA1716: Identificadores não devem corresponder a palavras-chave |
Um nome de namespace ou um nome de tipo corresponde a uma palavra reservada em uma linguagem de programação.Identificadores para namespaces e tipos não devem corresponder a palavras-chave que são definidas pelas linguagens que direcionam o common language runtime. |
O nome de um identificador visível externamente inclui um termo para o qual um termo alternativo e preferencial existe.Como alternativa, o nome inclui o termo "Bandeira" ou "Flags". |
|
Por convenção, os nomes de parâmetro usam camel casing e o espaço para nome, digite e nomes de membro Pascal casing. |
|
CA1702: Palavras compostas devem ser minúsculas corretamente |
O nome de um identificador contém várias palavras e pelo menos uma das palavras que parece ser uma palavra composta que não é causada corretamente. |
Nomes de membros de enumeração não são prefixados com o nome do tipo, porque as informações de tipo são esperadas a serem fornecidos pelas ferramentas de desenvolvimento. |
|
Por convenção, os nomes de tipos que ampliam a determinados tipos de base ou que implementar determinadas interfaces ou tipos derivados desses tipos, têm um sufixo que está associado com o tipo base ou interface. |