Regras de nomenclatura
As regras de nomenclatura dão suporte à adesão às convenções de nomenclatura das diretrizes de design do .NET.
Nesta seção
Regra | Descrição |
---|---|
CA1700: Não nomear valores de enumeração 'Reserved' | Essa regra pressupõe que um membro de enumeração que tenha um nome que contenha "reservado" não seja usado no momento, mas seja um espaço reservado a ser renomeado ou removido em uma versão futura. Renomear ou remover um membro é uma alteração drástica. |
CA1707: os identificadores não devem conter sublinhados | Por convenção, os nomes do identificador não contêm o caractere de sublinhado (_). Essa regra verifica namespaces, tipos, membros e parâmetros. |
CA1708: Os identificadores devem diferir mais do que maiúsculas e minúsculas | Os identificadores de namespaces, tipos, membros e parâmetros não podem se diferenciar apenas por maiúsculas porque linguagens com o Common Language Runtime como destino não precisam diferenciar maiúsculas e minúsculas. |
CA1710: os identificadores devem ter o sufixo correto | Por convenção, os nomes de tipos que estendem determinados tipos base ou que implementam determinadas interfaces, ou tipos derivados desses tipos, têm um sufixo associado ao tipo base ou à interface. |
CA1711: Identificadores não devem ter sufixos incorretos | Por convenção, apenas os nomes de tipos que estendem determinados tipos 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. |
CA1712: Não prefixar valores de enumeração com um nome de tipo | Os nomes dos membros de enumeração não são prefixados com o nome do tipo porque espera-se que as informações de tipo sejam fornecidas pelas ferramentas de desenvolvimento. |
CA1713: Eventos não devem ter o prefixo anterior ou posterior | O nome de um evento começa com "Antes" ou "Depois". Para nomear eventos relacionados gerados em uma sequência específica, use o tempo presente ou passado para indicar a posição relativa na sequência de ações. |
CA1714: Enumerações de sinalizadores devem ter nomes no plural | Uma enumeração pública tem o atributo System.FlagsAttribute e seu nome não termina em "s". Os tipos marcados com FlagsAttribute têm nomes que são plural porque o atributo indica que mais de um valor pode ser especificado. |
CA1715: os identificadores devem ter o prefixo correto | O nome de uma interface visível externamente não começa com um "I" maiúscula. O nome de um parâmetro de tipo genérico em um tipo ou método visível externamente não começa com um "T" maiúscula. |
CA1716: os identificadores não devem corresponder às palavras-chave | Um nome de namespace ou um nome de tipo corresponde a uma palavra-chave reservada em uma linguagem de programação. Os identificadores de namespaces e tipos não devem corresponder a palavras-chave definidas por idiomas destinados ao common language runtime. |
CA1717: Somente enumerações FlagsAttribute devem ter nomes plurais | As convenções de nomenclatura determinam que um nome plural para uma enumeração indica que mais de um valor da enumeração pode ser especificado ao mesmo tempo. |
CA1720: os identificadores não devem conter nomes de tipo | O nome de um 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ífico do idioma. |
CA1721: Nomes de propriedades não devem corresponder a métodos get | O nome de um membro público ou protegido começa com "Get" e, de outra forma, corresponde ao nome de uma propriedade pública ou protegida. Os métodos e as propriedades "Get" devem ter nomes que distinguem claramente sua função. |
CA1724: nomes de tipo não devem corresponder a namespaces | Os nomes de tipo não devem corresponder aos nomes dos namespaces do .NET. A violação dessa regra pode reduzir a usabilidade da biblioteca. |
CA1725: os nomes dos parâmetros devem corresponder à declaração base | A nomenclatura consistente de parâmetros em uma hierarquia de substituição aumenta a usabilidade das substituições do método. Um nome de parâmetro em um método derivado que difere do nome na declaração base pode causar confusão sobre se o método é uma substituição do método base ou uma nova sobrecarga do método. |
CA1727: Usar PascalCase para espaços reservados nomeados | Usar PascalCase para espaços reservados nomeados no modelo de mensagem de registro em log. |
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.