Dicas de programação: Como definir nomes em programação.

Dicas de programação

Nomenclatura de variáveis

Nomear as variáveis é um passo importante para conseguir construir um software, e os nomes das variáveis precisam identificar muito bem, o que aquele objeto contém.

É extremamente desaconselhado, nomear variáveis com apenas um caracter, isso é bem claro quando você está programando porém, com o passar do tempo, você esquecerá aquele significado e identificar o que foi atribuído aquela variável se tornará uma tarefa muito custosa, pois muito código deverá ser lido para encontrar o significado dela.

A dica é dar nomes significativos aos componentes, tanto objetos, classes, interfaces, como métodos, parâmetros e variáveis. Isso geralmente implica em ter um nome com mais de uma palavra para componente.

Gosto de colocar os objetos sempre no singular, uma vez que eles representam apenas um valor, a não ser que sejam listas, arrays, iteráveis ou mapas, estes sim vão no plural, pois representam mais de um valor. Assim, seguindo este padrão, toda vez que você mapear um objeto do banco de dados, imagine que estamos mapeando uma entidade chamada Leitor (você no caso), esta entidade terá algumas propriedades (colunas de uma tabela, caso esteja usando um banco com schema, ou valores de um json, ...). Imagine que foi definido que Leitor tem estas propriedades, id, nome, ip, lista[Visita].

Ao definir esta entidade, todos os nomes des suas propriedades ficariam no singular, a não ser a lista, esta sim ficaria no plural, veja a seguir

   objeto Leitor {

      numero privado id

      texto privado nome

      texto privado ip

      lista[Visita] privada sitesVisitados

  } 

Padrões de nomenclaturas

Existem alguns padrões de nomenclaturas, tanto pra variáveis, quanto para nomes dos objetos, os mais comuns são:

• camelCase: onde a primeira letra de cada palavra fica em maiúsculo, e o resto em minúsculo, para os nomes dos objetos. Já nos nomes das variáveis a primeira letra, sempre será em minúsculo, mas as outras primeiras letras das palavras serão maiúsculas, para o exemplo de nome sites visitados, neste padrão ficaraia assim.
• SitesVisitados: para nomes de enuns, interfaces, classes e objetos.
• sitesVisitados: para nomes de variáveis.
• snake_case: neste caso, todas as palavras ficam em minúsculo e elas são separadas por um '_', este padrão foi muito usado em linguagens como Lisp e COBOL, por isso também pode ser chamado de lisp_case, COBOL_CASE ou também kebab_case. Constantes, neste caso são definidas todas em MAIÚSCULO, no nosso exemplo ficaria assim:
• sites_visitados: para nomes de variáveis, enuns.
• Em alguns casos de snake case, o camelCase é usado para nomes de objetos e classes, como no python.

Esta será uma série de posts feitos aqui no blog que começa com este primeiro de nomenclatura.