Escolher nomes de variáveis que sigam as regras e convenções

6 minutos

Um desenvolvedor de software famoso uma vez disse: "a parte mais difícil do desenvolvimento de software é nomear as coisas". O nome de uma variável não só precisa seguir certas regras de sintaxe, ele também deve ser usado para tornar o código mais legível e compreensível. Isso é muito para se exigir de uma única linha de código!

Regras para nome de variáveis

Há algumas regras de nomenclatura de variáveis que são impostas pelo compilador do C#.

Os nomes de variáveis podem conter caracteres alfanuméricos e o caractere de sublinhado. Caracteres especiais como jogo da velha #, o traço - e o cifrão $ não são permitidos.
Os nomes de variáveis precisam começar com uma letra alfabética ou um sublinhado, não um número. Os desenvolvedores usam o sublinhado para uma finalidade especial, portanto, tente não usá-lo por enquanto.
Nomes de variável não podem ser uma palavra-chave do C#. Por exemplo, essas declarações de nome de variável não serão permitidas: float float; ou string string;.
Os nomes de variável diferenciam maiúsculas de minúsculas, o que significa que string MyValue; e string myValue; são duas variáveis diferentes.

Convenções de nome de variável

As convenções são sugestões acordadas pela comunidade de desenvolvimento de software. Embora você possa decidir não seguir essas convenções, elas são tão populares que fazer isso pode dificultar a compreensão de seus códigos por outros desenvolvedores. Pratique a adoção dessas convenções e torne-as parte do seu próprio repertório de codificação.

Os nomes de variável devem usar o 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;.
Nomes de variável devem ser descritivos e significativos no aplicativo. Escolha um nome para a variável que represente a particularidade dos dados que ela manterá (não o tipo de dados). Por exemplo, bool orderComplete; e NÃO bool isComplete;.
Os nomes de variável devem ser uma ou mais palavras inteiras unidas. Não use contratações porque o nome da variável pode não ser claro para outras pessoas que estão lendo seu código. Por exemplo, decimal orderAmount; e NÃO decimal odrAmt;.
Nomes de variável não devem incluir o tipo de dados da variável. Você pode vir a receber alguns conselhos de usar um estilo como string strMyValue;. Esse era um estilo popular há alguns anos. No entanto, a maioria dos desenvolvedores não segue mais esse conselho e há bons motivos para isso.

O exemplo string firstName; segue todas essas regras e convenções, supondo que eu queira usar essa variável para armazenar dados que representem o nome de uma pessoa.

Exemplos de nome de variável

Veja os seguites 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 tem um escopo definido no 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).

Há outros tipos de constructos que podem ser usados nos aplicativos e muitos deles têm as próprias convenções. Por exemplo, as classes geralmente são usadas na programação em C# e têm convenções associadas. Embora você não vá criar classes neste módulo, é importante saber que as convenções de nomenclatura que você acabou de aprender se enquadram em uma estrutura de nomenclatura maior.

Verificar seu conhecimento

Continuar