Caio Carrara Programador para o resto da vida. Falando sobre software e a vida.
Published

Sat 21 December 2013

←Home

Java Code Style (eclipse formatter e clean up)

Um ponto importante, mas que nem sempre é tratado com a seriedade que merece, é o code style dos projetos em que trabalhamos. Seja qual for a linguagem, escrevemos comportamentos para a máquina, mas quem mantém, altera e melhora esses comportamentos em formato de código são humanos. Assim sendo, nada mais importante do que pensar nisso quando estamos escrevendo código.

Graças as maravilhas do mundo moderno, os principais ambientes de desenvolvimento para a plataforma Java já podem formatar e limpar o código pra gente. No Eclipse, foco desse post, há duas funções básicas para isso: Code Formatter e Code Clean Up. O Clean Up além da formatação,  faz mais algumas coisas no código, exemplo: declara variável como final quando possível, adiciona o this quando necessário, organiza imports, etc. Ambos são bastante configuráveis.

Eu fiz um clean up meu, com base no que acho necessário. Eu sugeriria altamente a todos que trabalham com Java também usassem essa função. Podem configurar um Clean Up com as preferências pertinentes ao projeto que estão trabalhando, ou que a equipe de desenvolvedores ache melhor. Se desejarem, um ponto de partida pode ser o caio-eclipse-cleanup.xml

Também fiz um formatter. O que fiz é praticamente igual ao Code Style do Google para Java. O que fiz foi alterar o espaço das tabulações de 2 para 4 e a versão target do Java de 1.5 para 1.7. Todo o formatador é configurável, mas o arquivo que estou usando também pode ser utilizado como ponto de partida: eclipse-java-google-style.xml

Para usar os arquivos que disponibilizei é simples, após o download os mesmos precisam ser importados para os workspaces onde serão utilizados:
Code Formatter:

  • Eclipse > Window > Preferences > Java > Code Style > Formatter > Import...

Code Cleanup:

  • Eclipse > Window > Preferences > Java > Code Style > Clean Up > Import...

No dia a dia eu uso muito os atalhos:

  • Ctrl + Shift + F: aplica a formatação definida no Formatter
  • Ctrl + Shift + O: organiza os imports

Com esses atalhos, aquele código escrito rapidamente para um teste, protótipo ou mesmo exercício da faculdade, não tem mais desculpas para não ficar formatado corretamente. Afinal, é muito rápido e fácil utilizá-los.

Para passar o Clean Up:

Selecione um projeto, um pacote, um arquivo .java ou mesmo ctrl + a no arquivo fonte, clique com o botão direito: Source > Clean Up.

É isso. Espero que o código, além de performático e muito bom para as máquinas, também fique ótimo para ser lido pelos programadores!

Abraço!

Go Top
comments powered by Disqus