Convençôes de Código Java

As convenções de código são uma boa prática de programação. Ajudam por exemplo na manutenção de um sistema. A violação dessas “regras” prejudica em muito o entendimento de uma API, por exemplo...

por Eric C M Oliveira

As convenções de código são uma boa prática de programação. Ajudam por exemplo na manutenção de um sistema. A violação dessas “regras” prejudica em muito o entendimento de uma API, por exemplo. Além do mais, com as convenções, se é capaz de produzir um código legivel, “limpo”, que demonstra qualidade e de maneira profissional.

Abaixo descrevemos algumas das principais convenções Java:

Pacotes:

Deve obedecer a certa hierarquia, separadas por pontos. O uso de letras minúsculas é bem vindo, e raramente se faz usos de números. Se o pacote a ser utilizado é de fora da companhia ou organização, este deve começar com o domínio de internet redigido de forma contrária. Por exemplo, o pacote com.sun. Essas “partes” devem ser curtas, com até oito caracteres.

Em relação a bibliotecas padrão e pacotes opcionais, cujos nomes começam com java e javax, são exceções a esta regra e não são permitidos esses nomes para uso do desenvolvedor.

São permitidas abreviações, como por exemplo, o pacote util ao invés de utilities. O uso de acrônimos também é visto com bons olhos.

Classes:

Os nomes de classes e interfaces devem consistir em uma ou mais palavras, de preferência substantivos ou frases substantivas, com a primeira letra de cada palavra em letra maiúscula. Aqui abreviações devem ser evitadas.

Métodos e Atributos:

Devem seguir as mesmas convenções tipográficas de classes e interfaces, exceto que a primeira letra deve ser minúscula. Os métodos normalmente utilizam verbos ou frases verbais. Métodos que retornem um tipo boleano devem usar prefixo "is" seguido de um substantivo ou adjetivo, por exemplo, isEmployee.

Já os que retornam o resultado de uma função ou um atributo do objeto são nomeados com substantivos com ou sem o prefixo "get".

Em relação a JavaBeans, o uso do get e set (método para atribuir o valor a um atributo do objeto) são obrigatórios.

As variáveis locais seguem as mesmas convenções de métodos e campos, mas abreviações são permitidas.

Comentários:

A seguinte tipografia é uma das mais usadas:

/*
* Classname
*
* Version info
*
* Copyright notice
*/

Mas lembre-se de consultar a documentção Sun para a geração via comentários do popular e já tradicional Javadoc.

A maioria dos IDES do mercado tem configuração seguindo as convenções Java e notificam ao programador de eventuais “erros” durante a atividade de desenvolvimento, como podemos ver abaixo:

Note que usamos como nome de classe "linhaCodigo" e não "LinhaCodigo", como "manda" a convenção. Logo no alto do form, a ferramenta, nesse caso o IBM WSAD, informa que esse nome de classe não segue as convenções da linguagem.

Referências:

http://java.sun.com/docs/codeconv/

http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

http://www.csse.uwa.edu.au/programming/java-codeconv/