Escolha nomes de variáveis que sigam regras e convenções
- 6 minutos
Um desenvolvedor de software disse uma vez famosamente: "A parte mais difícil do desenvolvimento de software é nomear as coisas". O nome de uma variável não só tem de seguir certas regras de sintaxe, como também deve ser usado para tornar o código mais legível e compreensível. É pedir demais de uma única linha de código!
Regras de nomes de variáveis
Existem algumas regras de nomenclatura de variáveis que são impostas pelo compilador C#.
- Os nomes das variáveis podem conter caracteres alfanuméricos e o caractere sublinhado (_). Caracteres especiais como a libra
#, o traço-e o cifrão$não são permitidos. - Os nomes das variáveis devem começar com uma letra alfabética ou um sublinhado, não com um número. O uso de um caractere de sublinhado para iniciar um nome de variável normalmente é reservado para campos de instância privada. Um link para leitura adicional pode ser encontrado no resumo do módulo.
- Os nomes das variáveis NÃO devem ser uma palavra-chave C#. Por exemplo, estas declarações de nome de variável não serão permitidas:
float float;oustring string;. - Os nomes das variáveis são sensíveis a maiúsculas e minúsculas, o que significa que
string MyValue;estring myValue;são duas variáveis diferentes.
Convenções de nomes de variáveis
As convenções são sugestões acordadas pela comunidade de desenvolvimento de software. Embora você seja livre para decidir não seguir essas convenções, elas são tão populares que podem dificultar a compreensão do seu código por outros desenvolvedores. Você deve praticar a adoção dessas convenções e torná-las parte de seus próprios hábitos de codificação.
- Os nomes das variáveis devem usar camel case, que é um estilo de escrita que usa uma letra minúscula no início da primeira palavra e uma letra maiúscula no início de cada palavra subsequente. Por exemplo:
string thisIsCamelCase;. - Os nomes das variáveis devem ser descritivos e significativos em seu aplicativo. Você deve escolher um nome para sua variável que represente o tipo de dados que ela manterá (não o tipo de dados). Por exemplo:
bool orderComplete;, NÃObool isComplete;. - Os nomes das variáveis devem ser uma ou mais palavras inteiras anexadas. Não use contrações porque o nome da variável pode não estar claro para outras pessoas que estão a ler o teu código. Por exemplo:
decimal orderAmount;, NÃOdecimal odrAmt;. - Os nomes das variáveis não devem incluir o tipo de dados da variável. Você pode ver alguns conselhos para usar um estilo como
string strMyValue;. Era um estilo popular anos atrás. No entanto, a maioria dos desenvolvedores não segue mais este conselho e há boas razões para não usá-lo.
O exemplo string firstName; segue todas essas regras e convenções, supondo que você queira usar essa variável para armazenar dados que representam o primeiro nome de alguém.
Exemplos de nomes de variáveis
Aqui estão alguns exemplos de declarações de variáveis (usando tipos de dados comuns):
char userOption;
int gameScore;
float particlesPerMillion;
bool processedCustomer;
Outras convenções de nomenclatura
As regras e convenções descritas acima são para variáveis locais. Uma variável local é uma variável que tem escopo dentro do corpo de um método ou uma variável em um aplicativo de console que usa instruções de nível superior (como o código neste módulo).
Existem outros tipos de construções que você pode usar em seus aplicativos, e muitos têm suas próprias convenções. Por exemplo, as classes são frequentemente usadas na programação em C# e têm convenções associadas. Embora você não crie classes neste módulo, é importante que você saiba que as convenções de nomenclatura que você acabou de aprender se encaixam em uma estrutura de nomenclatura maior.