Como evitar que uma parte do código Java seja formatado pelo Eclipse

Em alguns momentos podemos ter a necessidade de evitar que o Eclipse formate uma parte específica do nosso código Java. Simplesmente deixar de formatar não parece ser uma boa ideia, pois qualquer outra pessoa da equipe pode inadvertidamente formatar o seu código. Inclusive pode ser que alguém resolva fazer um cleanup na classe, formatando ela toda.

Para evitar que o código seja formatado pelo Eclipse, a melhor solução é desabilitar a formatação nessa parte do código. O Eclipse possibilita isso através de um comentário especial chamado “@formatter“.

Para utilizar o “@formatter” é necessário primeiro configurar o Eclipse para permitir tal comentário. Para configurar basta ir nas preferências do Eclipse, depois Java > Code Style > Formatter. Depois clicar em “Edit” para abrir as configurações do formatador. Após isso basta marcar a flag “Enable Off/On tags” e clicar em “Apply”. Após essa configuração seu Eclipse já está pronto para desconsiderar as partes do código que você queira. Veja exemplo abaixo de como desabilitar a formatação em um pedaço do código.

algum código Java aqui //este código SERÁ formatado

// @formatter:off
algum código Java aqui //este código NÃO será formatado
// @formatter:on

algum código Java aqui //este código SERÁ formatado

O comentário @formatter também pode ficar dentro de um comentário já existente, como abaixo:

algum código Java aqui //este código SERÁ formatado

/*
algum comentário aqui. Este comentário SERÁ formatado

// @formatter:off
algum comentário aqui. Este comentário NÃO será formatado
// @formatter:on

algum comentário aqui. Este comentário SERÁ formatado
*/

algum código Java aqui //este código SERÁ formatado

Não esqueça de sempre reabilitar a formatação, utilizando o “@formatter:on”. Caso contrário todo o resto do código ficará com a formatação desabilitada.