Pausa para café #86. Um guia rápido e fácil para reformatar código no IntelliJ IDEA

Fonte: Lightrun Como desenvolvedor, você terá que fazer alterações na base de código. E se a base de código não estiver formatada claramente, a depuração se tornará muito mais difícil para você. Pequenas mudanças como reformatação e recuo adequado no código geralmente são ignoradas, mas obviamente ajudam a diferenciar a base de código de um desenvolvedor profissional da base de código de um iniciante. Manter a formatação e o recuo do código adequados ajudará você a escrever um código mais fácil de ler. Isso simplifica a colaboração em projetos, aumenta a velocidade de depuração e manutenção da base de código. O código fica mais legível e estruturado. É possível acelerar o processo de reformatação do código? Este artigo apresentará um método simples para reformatar código automaticamente usando o IntelliJ IDEA. Você aprenderá como reduzir o tempo necessário para esse procedimento e também como excluir partes da base de código da reformatação usando vários atalhos de teclado.

Benefícios da reformatação

É importante lembrar que nenhum código de formatação ou comentário é necessário para que a função funcione. Qualquer código, com ou sem formatação, pode ser totalmente lido e executado pelo compilador. Por outro lado, a reformatação torna a marcação muito mais fácil de ser lida pelas pessoas. Para o compilador, tudo o que importa é que o código funcione e que não contenha erros, e não quão bom ele é ou quão bem recuado está. É verdade que é este último que preocupa as pessoas, porque elas têm que ler esse código. Assim como acontece com o texto simples, ninguém gosta de ler conteúdo informe, sem títulos, parágrafos ou qualquer recuo. Algumas das técnicas de reformatação necessárias incluem:

• Recuar.
• Funções de estilo e escrita.
• Espaço vazio.
• Uso de letras maiúsculas e nomes.

A depuração é um mal necessário que um desenvolvedor encontrará frequentemente ao longo de sua carreira. Por onde começar se sua base de código estiver desordenada e desorganizada? Quando o código-fonte é formatado e recuado corretamente, ele parece menos agrupado. Isto torna mais fácil determinar onde os diferentes módulos de aplicação estão localizados. Consequentemente, fica mais fácil encontrar problemas e erros. A reformatação de código no IntelliJ IDEA é baseada nos requisitos especificados nas configurações de estilo de código no IDE. Embora, quando você usa o EditorConfig em seu projeto, as configurações especificadas no arquivo .editorconfig substituirão, por padrão, aquelas especificadas nas configurações de estilo de código. Reformatar no IntelliJ não é diferente de trabalhar em outros IDEs. Existem opções para reformatar um único bloco de código e o arquivo inteiro. Pode haver momentos em que todo o seu bloco de código seja bastante longo e você queira que tudo seja reformatado, exceto algumas áreas específicas. Nesse caso, escolher individualmente as partes do código que deseja formatar definitivamente não é a melhor opção. Nessas situações, a reformatação com o IntelliJ certamente será útil. Exploraremos este e outros usos do IDE.

Dicas para formatar código

Vejamos algumas dicas básicas para formatação de código em geral:

• Certifique-se de que seu código esteja comentado corretamente. Use comentários para transmitir intenção e significado. Mesmo que você seja o único lendo este código, ainda é útil lembrar-se da finalidade de certos blocos de código. Isso tornará as coisas mais fáceis se você retornar à sua base de código após as férias, por exemplo.

• Não use tabulações para espaços na mesma linha. Isso reduz a legibilidade do código.

• Adicione um TODO aos seus blocos de código para acompanhar implementações futuras. Dessa forma, ao reformatar seu código, não criará a ilusão de que seu trabalho está completo.

• Não use a reformatação de código como uma solução rápida para erros de sintaxe.

• Evite investimentos profundos. Esta é uma prática comum entre alguns desenvolvedores, mas o código profundamente aninhado dificulta a leitura e introduz erros que não são fáceis de detectar à primeira vista.

Reformatando código no IntelliJ IDEA

Antes de explorarmos diferentes maneiras de formatar código no IntelliJ, comece criando um projeto Java de amostra em seu IDE. Depois de iniciar o IntelliJ, você deverá ver uma tela como esta: Clique em Avançar e conclua a configuração de inicialização do projeto. Agora que seu projeto está configurado, é hora de adicionar código de amostra para ajudá-lo a entender a reformatação de código no IntelliJ. Este é um contador de palavras simples da Universidade do Texas:

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.TreeMap;

public class SimpleWordCounter {

    public static void main(String[] args) {
        try {
            File f = new File("ciaFactBook2008.txt");
            Scanner sc;
            sc = new Scanner(f);
            // sc.useDelimiter("[^a-zA-Z']+");
            Map<String, Integer> wordCount = new TreeMap<String, Integer>();
            while(sc.hasNext()) {
                String word = sc.next();
                if(!wordCount.containsKey(word))
                    wordCount.put(word, 1);
                else
                    wordCount.put(word, wordCount.get(word) + 1);
            }

            // show results
            for(String word : wordCount.keySet())
                System.out.println(word + " " + wordCount.get(word));
            System.out.println(wordCount.size());
        }
        catch(IOException e) {
            System.out.println("Unable to read from file.");
        }
    }
}

Reformatando trechos de código

Vamos começar formatando os trechos de código. Para fazer isso, basta destacar a parte do código que deseja formatar e clicar em Código > Reformatar Código . Como você pode ver, a parte destacada do seu código (neste caso, as linhas 11 a 17) está formatada corretamente. Vejamos o “antes” e o “depois” da reformatação do nosso trecho de código. Se você percebeu na primeira imagem, a declaração e inicialização da sua variável aconteceu na mesma linha do try . As chaves de fechamento são misturadas com o bloco else . Mas depois de destacar esta parte do seu código e usar a opção de reformatação, você terá um bloco de código mais agradável à vista. O código completo da sua classe agora se parece com isto: Observe que apenas o bloco de código selecionado foi reformatado.

Reformatando arquivos inteiros

Para reformatar o arquivo inteiro, abra o editor, coloque o cursor em qualquer lugar e clique em Código >Reformatar arquivo . Você será solicitado a selecionar as opções de reformatação apropriadas para o arquivo inteiro. Esta ação reformatará todo o seu código no editor ativo. Seu código ficará mais ou menos assim:

Reformatando um módulo ou diretório

Para fazer isso, tudo que você precisa fazer é clicar com o botão direito do mouse no módulo na janela de ferramentas do projeto e selecionar Reformatar código . Na janela pop-up, selecione qualquer uma das três opções necessárias:

• Otimizar importações : selecione esta opção se desejar adicionar instruções de importação ausentes e também eliminar importações não utilizadas.

• Reorganizar entradas : para reorganizar o código de acordo com as regras de layout especificadas nas configurações de estilo de código.

• Código de limpeza : para executar a limpeza do código.

Quando terminar, basta clicar em OK.

Excluindo código da reformatação

Vejamos o que fazer se você tiver um bloco de código que não deseja incluir ao formatar o arquivo inteiro. Vá para Arquivo > Configurações ou use o atalho de teclado Ctrl + Alt + S. Vá para Editor > Estilo de código e marque Habilitar marcadores do formatador no menu de comentários na guia Controle do formatador . No seu editor, crie um comentário de linha e digite //@formatter:off sem aspas no início da área que deseja excluir. No final da área, crie outra linha de comentário e digite //@formatter:on , também sem aspas. Na imagem acima, você pode ver que o formatador irá ignorar seu código na linha 23 simplesmente porque você o especificou nos comentários e no controlador de formato.

Exemplos de teclas de atalho para reformatação

• Reformatar bloco de código: Ctrl + Alt + Shift + L
• Reformatar arquivo: Ctrl + Alt + L
• Adicione um comentário à linha: Ctrl + /
• Adicionar comentário de bloco: Ctrl + Shift + /

Conclusão

Prestar atenção aos formatos de código é tão importante para um desenvolvedor quanto fazê-lo funcionar. Você nunca sabe quem acabará trabalhando em seu código. Ter uma base de código bem estruturada e fácil de ler indica um desenvolvedor profissional. Com o IntelliJ IDEA, formatar seu código não precisa ser tão difícil quanto escrever o próprio código. Da próxima vez que você escrever código usando o IntelliJ, use estas dicas. Isso facilitará sua vida na hora de depurar seu código.