terça-feira, 5 de outubro de 2010

Programação: Logica para nomes de variáveis e classes



Quando iniciamos no mundo da programação. Uma maneira de facilitar bastante a vida é aplicar um algumas regras simples aos nomes de variáveis e classes.

1ªRegra - Sobre as variáveis.

Sempre escreva os nomes das variáveis com letras minusculas.

Caso o nome da mesta tiver mais de uma palavra, é necessário escrever a primeira letra da palavra nova em maiúscula.

Evite colocar símbolos especiais como cecidilha(ç) palavras com acentos de qualquer forma (ã,â,ü, etc) para nome de variáveis ou para fazer parte do nome das mesmas.

Escreva nomes de variáveis que façam sentido.

Por exemplo se você tem um variável que representa o total de pessoas de um grupo não se abstenha em colocar um nome legível que possa facilitar uma futura manutenção:

Bons exemplos seriam:

totalPessoasGrupo, numeroPessoasGrupo, totalIntegrantesGrupo....etc

Nomes ruins seriam do tipo:


ngp, Npgru - De início esses nomes podem até ser simples, mas depois de um tempo no caso de uma manutenção estes podem atrasar um pouco a vida devido ao nome sem sentido aparente no futuro.



2º Regra - Sobre o nome de classes

Sempre que for escrever o nome de uma classe comece a nome da mesma com a primeira letra sendo maiúscula e a outras minusculas salvo se o nome da classe conter mais de duas palavras, a segue a regra do nome de variáveis onde cada nova palavra concatenada ao nome deve ter a primeira.

Evite colocar símbolos especiais como cecidilha(ç) palavras com acentos de qualquer forma (ã,â,ü, etc) para nome de variáveis ou para fazer parte do nome das mesmas.

Exemplos de bons nomes para classe:

Jogador, GeradorDeCodigo, Teste...

Nomes ruins seriam do tipo:

jogador, caça, avião.... - A primeira é ruim por o nome começado por letra minuscula, a segunda por ter carácter especial e a terceira por ter acento.






3º Regra  - Sobre o nome dos métodos


Sempre escreva os nomes dos métodos com a primeira letras do seu nome seja  minusculas.

Sempre escrever nomes que definam uma ação e que também tenham um sentido lógico.

Caso o nome da mesta tiver mais de uma palavra, é necessário escrever a primeira letra da palavra nova em maiúscula.

Evite colocar símbolos especiais como cecidilha(ç) palavras com acentos de qualquer forma (ã,â,ü, etc) para nome de variáveis ou para fazer parte do nome das mesmas.


Por exemplo você tem um método que faz soma de números, um bom nome seria somaNumeros:

Exemplos de bons nomes para método:

calcularMedia, gerarId, obterNome, getNome....

Nomes ruins seriam do tipo:

Nome, Média.....

Um comentário:

  1. Acho que rolou um google translate ai ein ... português pecaminoso ...

    ResponderExcluir