Boas práticas para nomes de variáveis e métodos

Programação Java
#1

Navegando pela internet achei um link importante, resolvi fazer um resumo: (abaixo)

  1. Use nomes de variáveis curtas ou longas o suficiente para cada escopo do código. Geralmente o tamanho usado é de 1 (um) caractere para contadores em loops; 1 (uma) palavra para variáveis de loops e condicionais; 1-2 palavras para nomes de métodos; 2-3 palavras para nomes de classes; 3-4 palavras para nomes de variáveis globais.

  2. Use nomes específicos para cada variável, “valor”, “igual”, “dados” não são nomes validos para nenhum caso.

  3. Use nomes “significativos” para as variáveis. Através do nome da variável você deve ser capaz de saber o que ela contém.

  4. Não inicie nomes de variáveis com o_, obj_, m_, etc. Uma variável não precisa de prefixos indicando o estado da variável.

  5. Obedeça aos padrões definidos na empresa onde trabalha e defina nomes de variáveis consistentes com cada aplicação, por exemplo, “txtUserName”, “lblUserName”, “cmbSchoolType”, caso contrário a falta de legibilidade irá ser prejudicada e o uso de ferramentas para “find/replace” será prejudicado.

  6. Obedeça aos padrões da linguagem de programação que está sendo utilizada, no caso do Java:
    :arrow: Use para nomes de classes: VelocityResponseWritter

:arrow: Use para nomes da pacotes: com.company.project.ui

:arrow: Use para nomes de variáveis: studentName

:arrow: Não use “_” (underscore) em lugar algum exceto para constantes e valores de enums.

  1. Não reuse o mesmo nome de variável na mesma classe em diferentes contextos.

  2. Não use o mesmo nome de variável para diferentes propósitos em um método ou condicional.

  3. Não use caracteres não-ASCII em nomes de variáveis.

  4. Não use tamanhos muito longos para nomes de variáveis (mais de 50 caracteres). Caso contrário ficará difícil de ler o código além de que o mesmo pode não rodar em alguns compiladores por causa da limitação de tamanho das linhas.

  5. Decida pelo uso de uma linguagem natural apenas: ou seja, só português ou só inglês.

  6. Use nomes significativos para nomes de métodos. O nome deve especificar exatamente a ação executada pelo método, em alguns casos o nome do método deve iniciar por um verbo.

  7. Use nomes significativos para os parâmetros dos métodos, dessa forma eles podem ser auto-explicativos sem a necessidade de uma documentação explicativa adicional.

Convenções de código do Java: http://www.oracle.com/technetwork/java/codeconv-138413.html

#2

Minha opinião, como todo padrão defina um que seja adequado a sua realidade e use, mas use mesmo.

Caso não seja fácil de usar então provavelmente precisa ser refeito.

Quando tiver usado com muita frequência se tornará hábito e achará estranho não usar.

Muitas horas gastas com manutenção de SW seriam evitadas se todos pensassem assim… :frowning:

#3

Talvez isso te interesse:

Código Limpo: Partes: 01,02,03,04,05

#4

Já agora, um pouco mais sucinto que o do Hebert, mas aqui fica http://www.javabuilding.com/principles/nomenclatura.html

#5

Eu uso essa convensão:
http://www.oracle.com/technetwork/java/codeconventions-150003.pdf

#6