Convenções de código são importantes para facilitar a manutenção e legibilidade do software. Elas melhoram a compreensão do código por outros programadores, já que 80% do custo de um software é com manutenção, geralmente não feita pelo programador original. As convenções para Java incluem usar maiúsculas para classes e minúsculas para métodos, variáveis com camel case, e constantes em maiúsculas com underline. Abreviar nomes dificulta a leitura e deve ser evitado.
2. Convenções de código são importantes para os
programadores para um certo número de razões:
◦ 80% do custo da vida útil de um software é com
manutenção.
◦ • Dificilmente qualquer software existente é mantido
por toda a sua vida pelo autor original.
◦ • Convenções de código melhoram a legibilidade do◦ • Convenções de código melhoram a legibilidade do
software, permitindo aos
◦ engenheiros/analistas/programadores entender o
novo código de forma mais rápida e
◦ completamente.
◦ • Se você enviar o seu código-fonte como um produto,
você precisa ter certeza de que está
◦ bem embalado e limpo como qualquer outro produto
que você cria. (ORACLE)
3. As regras básicas para nomes em programação Java
são bem simples e vale a pena memorizar:
◦ Os nomes de classe e interface começam com letra
maiúscula, como em Frame.
◦ • Os nomes de método, campo e variável local começam
com letra minúscula, como em
◦ read().
◦ • Os nomes de classe, método e campo todos usam◦ • Os nomes de classe, método e campo todos usam
minúsculas com maiúsculas em qualquer
◦ posição ("camel casing"), como em InputStream e
readFully().
◦ • Constantes — campos estáticos finais e
ocasionalmente variáveis locais finais — são
◦ escritas todas em letras maiúsculas com sublinhados
separando as palavras, como em MAX_CONNECTIONS.
◦ • Não abreviar
4. Nomes como sprintf e nmtkns são relíquias de
um tempo em que os supercomputadores tinham
32 KB de memória. Os compiladores
economizavam memória limitando os
identificadores a 8 caracteres ou menos.
Entretanto, isto já não é problema há mais de 30
anos.anos.
Hoje, não há desculpa para não escrever por
extenso os nomes de variáveis e métodos. Nada
marca um programa como o produto de um
hacker de C convertido mais obviamente que
nomes de variáveis sem vogais, como na
Listagem a seguir:
5.
6. Nomes não abreviados em “Camel Case” são
bem mais legíveis, como se pode ver na
listagem abaixo:
7. O código é mais frequentemente lido que escrito, e a linguagem
Java é otimizada para leitura. Os
programadores em C tem uma atração quase instintiva para
código ofuscado; Os programadores
Java não. A linguagem Java prioriza a legibilidade sobre a
concisão.
Algumas abreviações são tão comuns que você pode usá-las
sem culpa:sem culpa:
◦ max para máximo
◦ min para mínimo
◦ in para InputStream
◦ out para OutputStream
◦ e ou ex para uma exceção em uma cláusula catch (embora em nenhum
outro lugar)
◦ num para número, apesar de apenas quando usado como prefixo como
em numTokens, ou numHits
◦ tmp para uma variável temporária usada muito localmente — por
exemplo, ao trocar dois valores