Avisos de nomenclatura
Nomeando avisos dar suporte à conformidade com as convenções de nomenclatura das diretrizes de design de .NET Framework .
Nesta seção
Regra |
Descrição |
|---|---|
Esta regra pressupõe que um membro da enumeração que tenha um nome que contém “reservado” não é usado atualmente mas é um espaço reservado a ser renomeado ou removido em uma versão futura.Renomear ou remover um membro é uma alteração. |
|
CA1713: os eventos não devem ter um prefixo anterior ou posterior |
O nome de início de um evento com “antes de” ou “depois de”.Para nomear eventos relacionados que são gerados em uma sequência específica, use o tempo atual ou passado para indicar a posição relativa na sequência de ações. |
Uma enumeração pública tem o atributo de System.FlagsAttribute e seu nome não termina com “s”.Tipos que é marcado com FlagsAttribute tem nomes que são plural porque o atributo indica que mais de um valor pode ser especificado. |
|
CA1704: os identificadores do recurso devem ter a ortografia correta |
O nome de um identificador externamente visível contém uma ou mais palavras que não são reconhecidos pela biblioteca de SPELLING CHECKER da Microsoft. |
CA1708: os identificadores devem ser diferentes além de maiúsculas de minúsculas |
Os identificadores de namespaces, tipos, membros, e parâmetros não podem diferir somente por casos como os idiomas que visam Common Language Runtime não é necessário fazer diferenciação de maiúsculas e minúsculas. |
O nome de uma interface visível não externamente me começa com um capital “”. O nome de um parâmetro de tipo genérico em um tipo ou um método externamente visível não começa com um capital “T”. |
|
O nome de um parâmetro em um membro externamente visível contém um nome de tipo de dados, ou nome de um membro externamente visível contém um nome específico do idioma do tipo de dados. |
|
Por convenção, somente determinados elementos de programação têm nomes que começam com um prefixo específico. |
|
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. |
|
As convenções de nomenclatura ditam que um nome plural de uma enumeração indica que mais de um valor de enumeração pode ser especificado ao mesmo tempo. |
|
CA1725: os nomes de parâmetro devem corresponder à declaração base |
A nomeação consistente dos parâmetros em uma hierarquia de substituição aumentar a usabilidade das substituições do método.Um nome de parâmetro de um método derivada que difere do nome na declaração de base pode causar confusão quanto se o método for uma substituição do método de base ou de uma nova sobrecarga do método. |
CA1719: os nomes de parâmetro não devem corresponder aos nomes de membro |
Um nome de parâmetro deve comunicar o significado de um parâmetro, nome do membro deve comunicar o significado de um membro.Seria um design raro onde esses são os mesmos.Nomeando um parâmetro da mesma forma como o nome do membro é unintuitive e faz a biblioteca difícil usar. |
Cada palavra da cadeia de caracteres de recurso são divididas em tokens que são baseados em maiúsculas e minúsculas.Cada combinação contíguo de dois token é verificada pela biblioteca de SPELLING CHECKER da Microsoft.Se reconhecidas, as palavras gerenciem uma violação da regra. |
|
CA1703: as cadeias de caracteres do recurso devem ter a ortografia correta |
Uma cadeia de caracteres de recurso contém uma ou mais palavras que não são reconhecidos pela biblioteca de SPELLING CHECKER da Microsoft. |
CA1724: os nomes de tipo não devem corresponder a namespaces |
Os nomes de tipo não devem corresponder aos nomes de namespaces que são definidas na biblioteca de classes de .NET Framework .A violação desta regra pode reduzir a usabilidade de biblioteca. |
Por convenção, os nomes de identificadores não contêm o caractere de sublinhado (_).Esta regra verifica namespaces, tipos, membros, e parâmetros. |
|
CA1721: os nomes de propriedade não devem corresponder a métodos get |
O nome de um público ou inicia protegidos do membro com “e” correspondem a obtenção de outra forma o nome de um público ou de uma propriedade protegida. “Obter” métodos e as propriedades devem ter nomes que distinguem claramente a função. |
CA1716: os identificadores não devem corresponder a palavras-chave |
Um nome do namespace ou um nome de tipo correspondem a uma palavra-chave reservada em uma linguagem de programação.Os identificadores de namespaces e tipos não devem corresponder às palavras-chave que são definidos pelos idiomas que visam Common Language Runtime. |
O nome de um identificador externamente visível inclui um termo para que uma alternativa, termo preferido existe.Como alternativa, o nome inclui o termo “sinalizador” ou “sinalizadores”. |
|
CA1709: os identificadores do recurso devem ter maiúsculas e minúsculas corretas |
Por convenção, os nomes de parâmetros usam as caixas de camelo, e o namespace, digite e, os nomes de membro usam o uso de maiúsculas e minúsculas de Pascal. |
CA1702: palavras compostas devem ter maiúsculas e minúsculas corretas |
O nome de um identificador contiver várias palavras e, pelo menos uma das palavras parece ser uma palavra compostas que não sejam encaixotadas corretamente. |
CA1712: não use valores enum como prefixo com o nome do tipo |
Os nomes dos membros da enumeração não são prefixados com o nome do tipo como as informações de tipo deve ser fornecida por ferramentas de desenvolvimento. |
Por convenção, os nomes dos tipos que estendem determinados tipos de base ou que implementam determinadas interfaces, ou tipos derivados desses tipos, têm um sufixo associado ao tipo de base ou a interface. |