Kaffeepause Nr. 86. Eine schnelle und einfache Anleitung zum Neuformatieren von Code in IntelliJ IDEA

Quelle: Lightrun Als Entwickler müssen Sie Änderungen an der Codebasis vornehmen. Und wenn die Codebasis nicht klar formatiert ist, wird das Debuggen für Sie deutlich schwieriger. Kleine Änderungen wie Neuformatierung und korrekte Einrückung im Code werden normalerweise übersehen, aber sie helfen offensichtlich dabei, die Codebasis eines professionellen Entwicklers von der Codebasis eines Anfängers zu unterscheiden. Wenn Sie die richtige Formatierung und Einrückung des Codes beibehalten, können Sie leichter lesbaren Code schreiben. Dies vereinfacht die Zusammenarbeit an Projekten, erhöht die Geschwindigkeit beim Debuggen und bei der Pflege der Codebasis. Der Code wird lesbarer und strukturierter. Ist es möglich, den Code-Neuformatierungsprozess zu beschleunigen? In diesem Artikel stellen wir Ihnen eine einfache Methode zum automatischen Neuformatieren von Code mithilfe von IntelliJ IDEA vor. Sie erfahren, wie Sie die für diesen Vorgang erforderliche Zeit verkürzen und wie Sie mithilfe verschiedener Tastaturkürzel Teile der Codebasis von der Neuformatierung ausschließen.

Vorteile der Neuformatierung

Es ist wichtig zu bedenken, dass kein Formatierungs- oder Kommentarcode erforderlich ist, damit die Funktion funktioniert. Jeder Code, mit oder ohne Formatierung, kann vom Compiler vollständig gelesen und ausgeführt werden. Andererseits erleichtert die Neuformatierung die Lesbarkeit des Markups erheblich. Für den Compiler kommt es nur darauf an, dass der Code funktioniert und keine Fehler enthält, und nicht darauf, wie gut er ist oder wie schön er eingerückt ist. Es ist wahr, dass Letzteres den Menschen Sorgen bereitet, weil sie solchen Code lesen müssen. Genau wie bei reinem Text liest niemand gerne formlose Inhalte ohne Überschriften, Absätze oder Einrückungen. Zu den notwendigen Neuformatierungstechniken gehören:

• Einzug.
• Stil- und Schreibfunktionen.
• Freiraum.
• Verwendung von Großbuchstaben und Namen.

Debugging ist ein notwendiges Übel, mit dem ein Entwickler im Laufe seiner Karriere häufig konfrontiert wird. Wo soll man anfangen, wenn Ihre Codebasis überladen und unorganisiert ist? Wenn der Quellcode richtig formatiert und eingerückt ist, erscheint er weniger gruppiert. Dadurch lässt sich leichter feststellen, wo sich die verschiedenen Anwendungsmodule befinden. Dadurch wird es einfacher, Probleme und Fehler zu finden. Die Code-Neuformatierung in IntelliJ IDEA basiert auf den Anforderungen, die in den Codestileinstellungen in der IDE angegeben sind. Wenn Sie jedoch EditorConfig in Ihrem Projekt verwenden, überschreiben die Einstellungen, die Sie in der .editorconfig-Datei angeben, standardmäßig die in den Codestileinstellungen angegebenen. Die Neuformatierung in IntelliJ unterscheidet sich nicht von der Arbeit in anderen IDEs. Es gibt Optionen zum Neuformatieren sowohl eines einzelnen Codeblocks als auch der gesamten Datei. Es kann vorkommen, dass Ihr gesamter Codeblock recht lang ist und Sie möchten, dass bis auf einige bestimmte Bereiche alles neu formatiert wird. In diesem Fall ist es definitiv nicht die beste Option, die Teile des Codes, die Sie formatieren möchten, einzeln auszuwählen. In solchen Situationen wird sich eine Neuformatierung mit IntelliJ auf jeden Fall als nützlich erweisen. Wir werden diese und andere Verwendungsmöglichkeiten der IDE untersuchen.

Tipps zum Formatieren von Code

Schauen wir uns einige grundlegende Tipps zum Formatieren von Code im Allgemeinen an:

• Stellen Sie sicher, dass Ihr Code ordnungsgemäß kommentiert ist. Verwenden Sie Kommentare, um Absicht und Bedeutung zu vermitteln. Auch wenn Sie der Einzige sind, der diesen Code liest, ist es dennoch nützlich, sich an den Zweck bestimmter Codeblöcke zu erinnern. Dies erleichtert die Arbeit, wenn Sie beispielsweise nach einem Urlaub zu Ihrer Codebasis zurückkehren.

• Verwenden Sie keine Tabulatoren für Leerzeichen in derselben Zeile. Dies verringert die Lesbarkeit des Codes.

• Fügen Sie Ihren Codeblöcken ein TODO hinzu, um den Überblick über zukünftige Implementierungen zu behalten. Auf diese Weise entsteht bei der Neuformatierung Ihres Codes nicht der Eindruck, dass Ihre Arbeit abgeschlossen sei.

• Verwenden Sie die Code-Neuformatierung nicht als schnelle Lösung für Syntaxfehler.

• Vermeiden Sie hohe Investitionen. Dies ist bei einigen Entwicklern eine gängige Praxis, aber tief verschachtelter Code erschwert die Lesbarkeit und führt zu Fehlern, die auf den ersten Blick nicht leicht zu erkennen sind.

Code in IntelliJ IDEA neu formatieren

Bevor wir verschiedene Möglichkeiten zum Formatieren von Code in IntelliJ untersuchen, erstellen Sie zunächst ein Java-Beispielprojekt in Ihrer IDE. Sobald Sie IntelliJ starten, sollte ein Bildschirm wie dieser angezeigt werden: Klicken Sie auf „Weiter“ und schließen Sie die Einrichtung der Projektinitialisierung ab. Nachdem Ihr Projekt nun eingerichtet ist, ist es an der Zeit, Beispielcode hinzuzufügen, um Ihnen das Verständnis der Code-Neuformatierung in IntelliJ zu erleichtern. Dies ist ein einfacher Wortzähler der University of 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.");
        }
    }
}

Codefragmente neu formatieren

Beginnen wir mit der Formatierung der Codeausschnitte. Markieren Sie dazu einfach den Teil des Codes, den Sie formatieren möchten, und klicken Sie auf Code > Code neu formatieren . Wie Sie sehen, ist der hervorgehobene Teil Ihres Codes (in diesem Fall die Zeilen 11–17) korrekt formatiert. Schauen wir uns das „Vorher“ und „Nachher“ der Neuformatierung unseres Code-Snippets an. Wie Sie im ersten Bild bemerkt haben, erfolgte die Deklaration und Initialisierung Ihrer Variablen in derselben Zeile wie try . Die schließenden geschweiften Klammern werden mit dem else- Block gemischt . Aber nachdem Sie diesen Teil Ihres Codes markiert und die Neuformatierungsoption verwendet haben, erhalten Sie am Ende einen Codeblock, der optisch ansprechender ist. Der vollständige Code für Ihre Klasse sieht nun etwa so aus: Beachten Sie, dass nur der von Ihnen ausgewählte Codeblock neu formatiert wurde.

Ganze Dateien neu formatieren

Um die gesamte Datei neu zu formatieren, öffnen Sie den Editor, platzieren Sie den Cursor an einer beliebigen Stelle und klicken Sie auf Code > Datei neu formatieren . Sie werden aufgefordert, die entsprechenden Neuformatierungsoptionen für die gesamte Datei auszuwählen. Durch diese Aktion wird Ihr gesamter Code im aktiven Editor neu formatiert. Ihr Code wird etwa so aussehen:

Neuformatierung eines Moduls oder Verzeichnisses

Dazu müssen Sie lediglich mit der rechten Maustaste auf das Modul im Projekttoolsfenster klicken und „ Code neu formatieren“ auswählen . Wählen Sie im Popup-Fenster eine der drei gewünschten Optionen aus:

• Importe optimieren : Wählen Sie diese Option, wenn Sie fehlende Importanweisungen hinzufügen und auch ungenutzte Importe entfernen möchten.

• Einträge neu anordnen : Um den Code gemäß den in den Codestileinstellungen angegebenen Layoutregeln neu zu organisieren.

• Code bereinigen : um die Codebereinigung auszuführen.

Wenn Sie fertig sind, klicken Sie einfach auf OK.

Code von der Neuformatierung ausschließen

Schauen wir uns an, was zu tun ist, wenn Sie einen Codeblock haben, den Sie beim Formatieren der gesamten Datei nicht einschließen möchten. Gehen Sie zu Datei > Einstellungen oder verwenden Sie die Tastenkombination Strg + Alt + S. Gehen Sie zu Editor > Codestil und aktivieren Sie Formatierungsmarkierungen aktivieren im Kommentarmenü auf der Registerkarte Formatierungssteuerung . Erstellen Sie in Ihrem Editor einen Zeilenkommentar und geben Sie //@formatter:off ohne Anführungszeichen am Anfang des Bereichs ein, den Sie ausschließen möchten. Erstellen Sie am Ende des Bereichs einen weiteren Zeilenkommentar und geben Sie //@formatter:on ein , ebenfalls ohne Anführungszeichen. Im Bild oben können Sie sehen, dass der Formatierer Ihren Code in Zeile 23 ignoriert, nur weil Sie ihn in den Kommentaren und im Format-Controller angegeben haben.

Beispiele für Hotkeys zum Neuformatieren

• Codeblock neu formatieren: Strg + Alt + Umschalt + L
• Datei neu formatieren: Strg + Alt + L
• Fügen Sie der Zeile einen Kommentar hinzu: Strg + /
• Blockkommentar hinzufügen: Strg + Umschalt + /

Abschluss

Für einen Entwickler ist es genauso wichtig, auf Codeformate zu achten, wie dafür zu sorgen, dass er funktioniert. Sie können nie sagen, wer am Ende an Ihrem Code arbeiten wird. Eine leicht lesbare, gut strukturierte Codebasis zeugt von einem professionellen Entwickler. Mit IntelliJ IDEA muss die Formatierung Ihres Codes nicht so schwierig sein wie das Schreiben des Codes selbst. Wenn Sie das nächste Mal Code mit IntelliJ schreiben, verwenden Sie diese Tipps. Dies erleichtert Ihnen das Debuggen Ihres Codes.