Regras de nomenclatura
As regras de nomenclatura suportam a adesão às convenções de nomenclatura das diretrizes de design do .NET.
Nesta secção
Regra | Description |
---|---|
CA1700: Não atribuir nomes aos valores de enumeração "Reservado" | Esta regra pressupõe que um membro de enumeração que tenha um nome que contenha "reservado" não é atualmente utilizado, mas é um marcador de posição cujo nome deve ser mudado ou removido numa versão futura. Mudar o nome ou remover um membro é uma alteração interruptiva. |
CA1707: Os identificadores não devem conter carateres de sublinhado | Por convenção, os nomes dos identificadores não contêm o caráter de sublinhado (_). Esta regra verifica espaços de nomes, tipos, membros e parâmetros. |
CA1708: Os identificadores devem diferir mais do que o caso | Os identificadores para espaços de nomes, tipos, membros e parâmetros não podem diferir apenas por caso, porque os idiomas que visam o runtime de linguagem comum não têm de ser sensíveis às maiúsculas e minúsculas. |
CA1710: Os identificadores devem ter o sufixo correto | Por convenção, os nomes dos tipos que expandem determinados tipos de base ou que implementam determinadas interfaces ou tipos derivados destes tipos têm um sufixo associado ao tipo ou interface base. |
CA1711: Os identificadores não devem ter sufixo incorreto | Por convenção, apenas os nomes dos tipos que expandem determinados tipos de base ou que implementam determinadas interfaces ou tipos derivados destes tipos devem terminar com sufixos reservados específicos. Outros nomes de tipos não devem utilizar estes sufixos reservados. |
CA1712: Não prefixar valores de enumeração com o nome do tipo | Os nomes dos membros de enumeração não têm o prefixo do tipo, porque espera-se que as informações de tipo sejam fornecidas pelas ferramentas de desenvolvimento. |
CA1713: Os eventos não devem ter antes ou depois do prefixo | O nome de um evento começa com "Antes" ou "Depois". Para atribuir nomes a eventos relacionados que são gerados numa sequência específica, utilize o tempo presente ou passado para indicar a posição relativa na sequência de ações. |
CA1714: As enumerações de sinalizadores devem ter nomes plural | Uma enumeração pública tem o atributo System.FlagsAttribute e o respetivo nome não termina em "s". Os tipos marcados com FlagsAttribute têm nomes que são plural porque o atributo indica que pode ser especificado mais do que um valor. |
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 num tipo ou método visível externamente não começa com um "T" maiúscula. |
CA1716: Os identificadores não devem corresponder a palavras-chave | Um nome de espaço de nomes ou um nome de tipo corresponde a uma palavra-chave reservada numa linguagem de programação. Os identificadores para espaços de nomes e tipos não devem corresponder a palavras-chave definidas por idiomas que visam o runtime de linguagem comum. |
CA1717: Apenas flagsAttribute enums devem ter nomes plural | As convenções de nomenclatura ditam que um nome plural para uma enumeração indica que mais do que um valor da enumeração pode ser especificado ao mesmo tempo. |
CA1720: Os identificadores não devem conter nomes de tipos | O nome de um parâmetro num 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 da linguagem. |
CA1721: Os nomes das propriedades não devem corresponder aos métodos get | O nome de um membro público ou protegido começa por "Obter" e, caso contrário, corresponde ao nome de uma propriedade pública ou protegida. Os métodos e propriedades "Get" devem ter nomes que distinguem claramente a respetiva função. |
CA1724: Nomes de Tipos Não Devem Corresponder Aos Espaços de Nomes | Os nomes dos tipos não devem corresponder aos nomes dos espaços de nomes .NET. A violação desta regra pode reduzir a utilização da biblioteca. |
CA1725: Os nomes dos parâmetros devem corresponder à declaração de base | A nomenclatura consistente de parâmetros numa hierarquia de substituição aumenta a utilização das substituições do método. Um nome de parâmetro num método derivado que difere do nome na declaração de 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: Utilizar PascalCase para marcadores de posição nomeados | Utilize PascalCase para marcadores de posição nomeados no modelo de mensagem de registo. |
Colabore connosco no GitHub
A origem deste conteúdo pode ser encontrada no GitHub, onde também pode criar e rever problemas e pedidos Pull. Para mais informações, consulte o nosso guia do contribuidor.