Pausa caffè #86. Una guida semplice e veloce per riformattare il codice in IntelliJ IDEA

Fonte: Lightrun Come sviluppatore, dovrai apportare modifiche al codice base. E se la base di codice non è formattata in modo chiaro, il debug diventerà molto più difficile per te. Piccole modifiche come la riformattazione e il rientro corretto nel codice vengono solitamente trascurate, ma ovviamente aiutano a differenziare la base di codice di uno sviluppatore professionista da quella di un principiante. Mantenere la formattazione e il rientro corretti del codice ti aiuterà a scrivere codice più facile da leggere. Ciò semplifica la collaborazione sui progetti, aumenta la velocità di debug e il mantenimento della base di codice. Il codice diventa più leggibile e strutturato. È possibile accelerare il processo di riformattazione del codice? Questo articolo ti introdurrà a un metodo semplice per riformattare automaticamente il codice utilizzando IntelliJ IDEA. Imparerai come ridurre il tempo richiesto per questa procedura e imparerai anche come escludere parti della base di codice dalla riformattazione utilizzando varie scorciatoie da tastiera.

Vantaggi della riformattazione

È importante ricordare che non è richiesto alcun codice di formattazione o commento affinché la funzione funzioni. Qualsiasi codice, con o senza formattazione, può essere completamente letto ed eseguito dal compilatore. D'altro canto, la riformattazione rende il markup molto più semplice da leggere. Per il compilatore, tutto ciò che conta è che il codice funzioni e che non contenga errori, e non quanto sia buono o quanto sia ben rientrato. È vero, è quest'ultimo che preoccupa le persone, perché devono leggere tale codice. Proprio come con il testo semplice, a nessuno piace leggere contenuti informi senza intestazioni, paragrafi o rientri. Alcune delle tecniche di riformattazione necessarie includono:

• Rientro.
• Funzioni di stile e scrittura.
• Spazio vuoto.
• Uso delle maiuscole e dei nomi.

Il debug è un male necessario che uno sviluppatore incontrerà frequentemente nel corso della sua carriera. Da dove iniziare se la tua base di codice è disordinata e disorganizzata? Quando il codice sorgente è formattato e rientrato correttamente, appare meno raggruppato. Ciò rende più semplice determinare dove si trovano i diversi moduli dell'applicazione. Di conseguenza diventa più facile trovare problemi ed errori. La riformattazione del codice in IntelliJ IDEA si basa sui requisiti specificati nelle impostazioni dello stile del codice nell'IDE. Tuttavia, quando utilizzi EditorConfig nel tuo progetto, le impostazioni specificate nel file .editorconfig sovrascriveranno per impostazione predefinita quelle specificate nelle impostazioni dello stile del codice. La riformattazione in IntelliJ non è diversa dal lavoro in altri IDE. Sono disponibili opzioni per riformattare sia un singolo blocco di codice che l'intero file. Potrebbero esserci momenti in cui l'intero blocco di codice è piuttosto lungo e desideri che tutto venga riformattato tranne alcune aree specifiche. In questo caso, scegliere individualmente le parti del codice che desideri formattare non è sicuramente la soluzione migliore. In tali situazioni, la riformattazione con IntelliJ tornerà sicuramente utile. Esploreremo questo e altri usi dell'IDE.

Suggerimenti per la formattazione del codice

Diamo un'occhiata ad alcuni suggerimenti di base per la formattazione del codice in generale:

• Assicurati che il tuo codice sia commentato correttamente. Utilizza i commenti per trasmettere intenti e significato. Anche se sei l'unico a leggere questo codice, è comunque utile ricordare lo scopo di alcuni blocchi di codice. Ciò renderà le cose più facili se, ad esempio, ritorni alla tua codebase dopo una vacanza.

• Non utilizzare tabulazioni per gli spazi sulla stessa riga. Ciò riduce la leggibilità del codice.

• Aggiungi una TODO ai tuoi blocchi di codice per tenere traccia delle implementazioni future. In questo modo, quando riformatterai il tuo codice, non creerai l'illusione che il tuo lavoro sia completo.

• Non utilizzare la riformattazione del codice come soluzione rapida per errori di sintassi.

• Evita investimenti profondi. Questa è una pratica comune tra alcuni sviluppatori, ma il codice profondamente annidato rende difficile la lettura e introduce errori che non sono facili da individuare a prima vista.

Riformattazione del codice in IntelliJ IDEA

Prima di esplorare diversi modi per formattare il codice in IntelliJ, inizia creando un progetto Java di esempio nel tuo IDE. Una volta avviato IntelliJ, dovresti vedere una schermata come questa: Fai clic su Avanti e completa la configurazione di inizializzazione del progetto. Ora che il tuo progetto è configurato, è il momento di aggiungere codice di esempio per aiutarti a comprendere la riformattazione del codice in IntelliJ. Questo è un semplice contatore di parole dell'Università del 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.");
        }
    }
}

Riformattazione di frammenti di codice

Iniziamo formattando i frammenti di codice. Per fare ciò, evidenzia semplicemente la parte del codice che desideri formattare e fai clic su Codice > Riformatta codice . Come puoi vedere, la parte evidenziata del tuo codice (in questo caso le righe 11-17) è formattata correttamente. Diamo un'occhiata al "prima" e al "dopo" della riformattazione del nostro snippet di codice. Se hai notato nella prima immagine, la dichiarazione e l'inizializzazione della tua variabile sono avvenute sulla stessa riga di try . Le parentesi graffe di chiusura sono mescolate con il blocco else . Ma dopo aver evidenziato questa parte del codice e utilizzato l'opzione di riformattazione, ti ritroverai con un blocco di codice più gradevole alla vista. Il codice completo per la tua classe ora assomiglia a questo: Nota che solo il blocco di codice selezionato è stato riformattato.

Riformattare interi file

Per riformattare l'intero file, apri l'editor, posiziona il cursore in un punto qualsiasi e fai clic su Codice >Riformatta file . Ti verrà richiesto di selezionare le opzioni di riformattazione appropriate per l'intero file. Questa azione riformatterà tutto il codice nell'editor attivo. Il tuo codice diventerà qualcosa del genere:

Riformattare un modulo o una directory

Per fare ciò, tutto ciò che devi fare è fare clic con il pulsante destro del mouse sul modulo nella finestra degli strumenti del progetto e selezionare Riformatta codice . Nella finestra pop-up, seleziona una delle tre opzioni necessarie:

• Ottimizza importazioni : seleziona questa opzione se desideri aggiungere istruzioni di importazione mancanti ed eliminare anche le importazioni inutilizzate.

• Riorganizzare le voci : per riorganizzare il codice in base alle regole di layout specificate nelle impostazioni dello stile del codice.

• Codice di pulizia : per eseguire la pulizia del codice.

Quando hai finito, fai semplicemente clic su OK.

Escludere il codice dalla riformattazione

Diamo un'occhiata a cosa fare se hai un blocco di codice che non vuoi includere durante la formattazione dell'intero file. Vai su File > Impostazioni o usa la scorciatoia da tastiera Ctrl + Alt + S. Vai su Editor > Stile codice e seleziona Abilita marcatori formattatore nel menu Commenti nella scheda Controllo formattatore . Nel tuo editor, crea una riga di commento e digita //@formatter:off senza virgolette all'inizio dell'area che desideri escludere. Alla fine dell'area, crea un'altra riga di commento e inserisci //@formatter:on , anche questo senza virgolette. Nell'immagine sopra, puoi vedere che il formattatore ignorerà il tuo codice alla riga 23 semplicemente perché lo hai specificato nei commenti e nel controller del formato.

Esempi di tasti di scelta rapida per la riformattazione

• Riformatta il blocco di codice: Ctrl + Alt + Maiusc + L
• Riformatta il file: Ctrl + Alt + L
• Aggiungi un commento alla riga: Ctrl + /
• Aggiungi commento al blocco: Ctrl + Maiusc + /

Conclusione

Prestare attenzione ai formati del codice è importante per uno sviluppatore tanto quanto farlo funzionare. Non puoi mai sapere chi finirà per lavorare sul tuo codice. Avere una base di codice facile da leggere e ben strutturata parla di uno sviluppatore professionista. Con IntelliJ IDEA, formattare il codice non deve essere difficile quanto scrivere il codice stesso. La prossima volta che scrivi codice usando IntelliJ, usa questi suggerimenti. Ciò ti semplificherà la vita durante il debug del codice.