Convenções maiúsculas
Muitas das convenções de nomenclatura pertencem às maiúsculas e minúsculas dos identificadores. É importante observar que o common language runtime (CLR) oferece suporte a idiomas diferencia maiúsculas de minúsculas e maiúsculas de minúsculas. As convenções de maiúsculas e minúsculas descritas neste tópico facilitam para os desenvolvedores a compreender e trabalhar com uma biblioteca.
Estilos de capitalização
Os termos a seguir descrevem as maneiras diferentes de identificadores de maiúsculas.
Pascal Casing
A primeira letra do identificador e a primeira letra de cada palavra concatenada subseqüente estão em maiúsculas. Você pode usar o caso do Pascal para identificadores de três ou mais caracteres. Por exemplo:
BackColor
Camel Casing
A primeira letra de um identificador é minúscula e a primeira letra de cada palavra concatenada subseqüente é maiúscula. Por exemplo:
backColor
Letras maiúsculas
O identificador de todas as letras são maiúsculas. Por exemplo:
IO
Regras de capitalização para identificadores
Quando um identificador consiste em várias palavras, não use separadores, como, por exemplo, caracteres de sublinhado ("_") ou hifens ("-"), entre as palavras. Em vez disso, use casing para indicar o início de cada palavra.
As diretrizes a seguir fornecem as regras gerais para identificadores.
Use Pascal casing para todos os públicos espaço para nome, tipo e membro nomes consiste em várias palavras.
Observe que esta regra não se aplica a campos de instância. Por motivos são detalhados na Diretrizes de Design do membro, você não deve usar campos de instância pública.
Use o camel casing para nomes de parâmetro.
A tabela a seguir resume as regras de capitalização para identificadores e fornece exemplos para os diferentes tipos de identificadores.
Identificador |
Case |
Exemplo |
|---|---|---|
Classe |
Pascal |
AppDomain |
Tipo de enumeração |
Pascal |
ErrorLevel |
Valores de enumeração |
Pascal |
FatalError |
Evento |
Pascal |
ValueChanged |
Classe de exceção |
Pascal |
WebException |
Campo estático somente leitura |
Pascal |
RedValue |
Interface |
Pascal |
IDisposable |
Método |
Pascal |
ToString |
Namespace |
Pascal |
System.Drawing |
Parâmetro |
Camelo |
typeName |
Propriedade |
Pascal |
BackColor |
Regras de capitalização de acrônimos
Um acrônimo é uma palavra que é formada de letras das palavras em um termo ou frase. Por exemplo, o HTML é o acrônimo de Hypertext Markup Language. Você deve incluir os acrônimos em identificadores somente quando elas são amplamente conhecidas e bem compreendidas. Acrônimos diferem dos abreviações de abreviação diminui a uma única palavra. Por exemplo, ID é uma abreviação de identifier. Em geral, os nomes da biblioteca não devem usar abreviações.
Observação
As duas abreviações que podem ser usadas em identificadores são ID e OK.Em minúsculas de Pascal identificadores deve aparecer como Id, e Ok.Se usado como a primeira palavra em um identificador concatenados, eles devem aparecer como id e ok, respectivamente.
A capitalização acrônimos depende do comprimento do acrônimo. Todos os acrônimos são pelo menos dois caracteres. Para os objetivos dessas diretrizes, o acrônimo é exatamente dois caracteres, ele é considerado um acrônimo curto. Acrônimo de três ou mais caracteres é um acrônimo longo.
As diretrizes a seguir especificam a capitalização correta para os acrônimos de curtos e longos. Rules de identificador têm precedência sobre o acrônimo rules de caixa.
Capitalizar os dois caracteres de dois caracteres de acrônimos, exceto a primeira palavra de um identificador concatenados.
Uma propriedade chamada DBRate é um exemplo de um acrônimo curto (DB) usado como a primeira palavra de um identificador minúsculas de Pascal. Um parâmetro chamado ioChannel é um exemplo de um acrônimo curto (IO) usado como a primeira palavra de um identificador concatenados.
Use maiúsculas apenas o primeiro caractere de acrônimos com três ou mais caracteres, exceto a primeira palavra de um identificador concatenados.
Uma classe chamada XmlWriter é um exemplo de um acrônimo longo é usado como a primeira palavra de um identificador minúsculas de Pascal. Um parâmetro chamado htmlReader é um exemplo de um acrônimo longo é usado como a primeira palavra de um identificador concatenados.
Não capitalizar os caracteres de qualquer acrônimos, seja qual for seu comprimento, no início de um identificador concatenados.
Um parâmetro chamado xmlStream é um exemplo de um acrônimo longo (xml) usado como a primeira palavra de um identificador concatenados. Um parâmetro chamado dbServerName é um exemplo de um acrônimo curto (db) usado como a primeira palavra de um identificador concatenados.
Regras de capitalização para palavras compostas e termos comuns
Não é capitalizar cada palavra em supostas palavras compostas de forma fechada. Essas são as palavras compostas escritas como uma única palavra, como, por exemplo, "ponto de extremidade".
Por exemplo, hashtable é uma palavra composta de forma fechada que deve ser tratada como uma única palavra e minúsculas adequadamente. No caso do Pascal, é Hashtable; no caso do camel, é hashtable. Para determinar se uma palavra é uma palavra composta de forma fechada, verifique um dicionário atual.
A lista a seguir identifica alguns termos comuns que não são palavras compostas de forma fechada. O word é mostrado na Pascal casing seguido pelo formulário concatenados entre parênteses.
BitFlag (bitFlag)
FileName (fileName)
LogOff (logOff)
LogOn (logOn)
SignIn (signIn)
SignOut (signOut)
UserName (userName)
WhiteSpace (whiteSpace)
Com diferenciação de maiúsculas e minúsculas
As diretrizes de capitalização existem unicamente para facilitar a leitura e reconhecer identificadores. A capitalização não pode ser usada como um meio de evitar conflitos de nome entre elementos da biblioteca.
Não assuma que todas as linguagens de programação diferenciam maiúsculas de minúsculas. Eles não são. Nomes não podem diferir por caso sozinho.
Portions Copyright 2005 Microsoft Corporation. Todos os direitos reservados.
Portions Copyright Addison-Wesley Corporation. Todos os direitos reservados.
Para obter mais informações sobre as diretrizes de design, consulte a "diretrizes de Design do Framework: Convenções, idiomas e padrões de reutilizável.Bibliotecas de rede" catálogo por Krzysztof Cwalina e Brad Abrams, publicado pela Addison-Wesley, 2005.
Consulte também
Outros recursos
Diretrizes de Design para desenvolvimento bibliotecas de classe