Przerwa kawowa #86. Szybki i łatwy przewodnik po ponownym formatowaniu kodu w IntelliJ IDEA

Źródło: Lightrun Jako programista będziesz musiał wprowadzić zmiany w kodzie. A jeśli baza kodu nie jest wyraźnie sformatowana, debugowanie stanie się dla Ciebie znacznie trudniejsze. Drobne zmiany, takie jak przeformatowanie i odpowiednie wcięcia w kodzie, są zwykle pomijane, ale w oczywisty sposób pomagają one odróżnić bazę kodu profesjonalnego programisty od bazy kodu początkującego. Utrzymanie prawidłowego formatowania i wcięć kodu pomoże Ci napisać kod, który będzie łatwiejszy do odczytania. Upraszcza to współpracę przy projektach, zwiększa szybkość debugowania i utrzymania bazy kodu. Kod staje się bardziej czytelny i uporządkowany. Czy można przyspieszyć proces formatowania kodu? W tym artykule zapoznasz się z prostą metodą automatycznego ponownego formatowania kodu przy użyciu IntelliJ IDEA. Dowiesz się, jak skrócić czas potrzebny na tę procedurę, a także dowiesz się, jak wykluczyć części bazy kodu z ponownego formatowania za pomocą różnych skrótów klawiaturowych.

Korzyści z formatowania

Należy pamiętać, że aby funkcja działała, nie jest wymagane żadne formatowanie ani kod komentowania. Kompilator może w całości odczytać i wykonać dowolny kod, z formatowaniem lub bez. Z drugiej strony, ponowne formatowanie sprawia, że ​​znaczniki są znacznie łatwiejsze do odczytania. Dla kompilatora liczy się tylko to, czy kod działa i czy nie zawiera błędów, a nie to, jak dobry jest i jak ładnie ma wcięcia. To prawda, że ​​​​ludzi martwi się to drugie, ponieważ muszą czytać taki kod. Podobnie jak w przypadku zwykłego tekstu, nikt nie lubi czytać bezkształtnych treści bez nagłówków, akapitów i wcięć. Niektóre z niezbędnych technik ponownego formatowania obejmują:

• Akapit.
• Funkcje stylu i pisania.
• Pusta przestrzeń.
• Używanie wielkich liter i imion.

Debugowanie to zło konieczne, z którym programista często spotyka się w swojej karierze. Od czego zacząć, jeśli baza kodu jest zaśmiecona i zdezorganizowana? Gdy kod źródłowy jest prawidłowo sformatowany i ma wcięcia, wydaje się mniej skupiony. Ułatwia to określenie, gdzie znajdują się różne moduły aplikacji. W rezultacie łatwiej jest znaleźć problemy i błędy. Przeformatowanie kodu w IntelliJ IDEA opiera się na wymaganiach określonych w ustawieniach stylu kodu w IDE. Chociaż w przypadku użycia EditorConfig w projekcie ustawienia określone w pliku .editorconfig domyślnie zastąpią ustawienia określone w ustawieniach stylu kodu. Ponowne formatowanie w IntelliJ nie różni się od pracy w innych IDE. Istnieją opcje ponownego formatowania zarówno pojedynczego bloku kodu, jak i całego pliku. Może się zdarzyć, że cały blok kodu będzie dość długi i będziesz chciał sformatować wszystko z wyjątkiem kilku określonych obszarów. W takim przypadku samodzielne wybieranie fragmentów kodu, które chcemy sformatować, na pewno nie jest najlepszym rozwiązaniem. W takich sytuacjach na pewno przyda się ponowne sformatowanie za pomocą IntelliJ. Zbadamy to i inne zastosowania IDE.

Wskazówki dotyczące formatowania kodu

Przyjrzyjmy się ogólnie kilku podstawowym wskazówkom dotyczącym formatowania kodu:

• Upewnij się, że Twój kod jest odpowiednio skomentowany. Użyj komentarzy, aby przekazać intencję i znaczenie. Nawet jeśli jesteś jedyną osobą czytającą ten kod, nadal warto przypomnieć sobie o przeznaczeniu niektórych bloków kodu. Ułatwi to sprawę, jeśli na przykład wrócisz do swojej bazy kodu po wakacjach.

• Nie używaj tabulatorów zamiast spacji w tym samym wierszu. Zmniejsza to czytelność kodu.

• Dodaj TODO do swoich bloków kodu, aby śledzić przyszłe wdrożenia. W ten sposób ponowne sformatowanie kodu nie stworzy złudzenia, że ​​praca została ukończona.

• Nie używaj ponownego formatowania kodu jako szybkiego rozwiązania błędów składniowych.

• Unikaj głębokich inwestycji. Jest to powszechna praktyka wśród niektórych programistów, ale głęboko zagnieżdżony kod utrudnia czytanie i wprowadza błędy, które nie są łatwe do wykrycia na pierwszy rzut oka.

Ponowne formatowanie kodu w IntelliJ IDEA

Zanim poznamy różne sposoby formatowania kodu w IntelliJ, zacznij od utworzenia przykładowego projektu Java w swoim IDE. Po uruchomieniu IntelliJ powinieneś zobaczyć następujący ekran: Kliknij Dalej i zakończ konfigurację inicjalizacji projektu. Teraz, gdy projekt jest już skonfigurowany, czas dodać przykładowy kod, który pomoże Ci zrozumieć formatowanie kodu w IntelliJ. Oto prosty licznik słów opracowany przez Uniwersytet w Teksasie:

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.");
        }
    }
}

Ponowne formatowanie fragmentów kodu

Zacznijmy od sformatowania fragmentów kodu. Aby to zrobić, po prostu zaznacz część kodu, którą chcesz sformatować i kliknij Kod > Zmień format kodu . Jak widać, podświetlona część kodu (w tym przypadku linie 11-17) jest poprawnie sformatowana. Przyjrzyjmy się „przed” i „po” formatowaniu naszego fragmentu kodu. Jeśli zauważyłeś na pierwszym obrazku, deklaracja i inicjalizacja zmiennej odbyła się w tym samym wierszu, co try . Zamykające nawiasy klamrowe są zmieszane z blokiem else . Jednak po zaznaczeniu tej części kodu i skorzystaniu z opcji ponownego formatowania otrzymasz blok kodu, który będzie przyjemniejszy dla oka. Kompletny kod Twojej klasy wygląda teraz mniej więcej tak: Zauważ, że tylko wybrany blok kodu został przeformatowany.

Ponowne formatowanie całych plików

Aby sformatować cały plik, otwórz edytor, umieść kursor w dowolnym miejscu i kliknij Kod >Reformatuj plik . Zostaniesz poproszony o wybranie odpowiednich opcji formatowania całego pliku. Ta czynność spowoduje ponowne sformatowanie całego kodu w aktywnym edytorze. Twój kod będzie wyglądał mniej więcej tak:

Ponowne formatowanie modułu lub katalogu

Aby to zrobić wystarczy kliknąć prawym przyciskiem myszy moduł w oknie narzędzi projektowych i wybrać opcję Reformat Code . W wyskakującym oknie wybierz dowolną z trzech potrzebnych opcji:

• Optymalizuj importy : wybierz tę opcję, jeśli chcesz dodać brakujące instrukcje importu, a także pozbyć się nieużywanych importów.

• Zmień kolejność wpisów : Aby zreorganizować kod zgodnie z zasadami układu określonymi w ustawieniach stylu kodu.

• Kod czyszczący : aby uruchomić czyszczenie kodu.

Kiedy skończysz, po prostu kliknij OK.

Wykluczanie kodu z ponownego formatowania

Przyjrzyjmy się, co zrobić, jeśli masz blok kodu, którego nie chcesz dołączać podczas formatowania całego pliku. Przejdź do Plik > Ustawienia lub użyj skrótu klawiaturowego Ctrl + Alt + S. Przejdź do Edytor > Styl kodu i zaznacz opcję Włącz znaczniki formatowania w menu komentarzy na karcie Kontrola formatowania . Utwórz w edytorze komentarz liniowy i wpisz //@formatter:off bez cudzysłowów na początku obszaru, który chcesz wykluczyć. Na końcu obszaru utwórz kolejny komentarz liniowy i wpisz //@formatter:on , również bez cudzysłowu. Na powyższym obrazku widać, że program formatujący zignoruje kod w linii 23. tylko dlatego, że podałeś go w komentarzach i kontrolerze formatu.

Przykłady skrótów klawiszowych do ponownego formatowania

• Sformatuj ponownie blok kodu: Ctrl + Alt + Shift + L
• Sformatuj plik: Ctrl + Alt + L
• Dodaj komentarz do linii: Ctrl + /
• Dodaj komentarz do bloku: Ctrl + Shift + /

Wniosek

Zwracanie uwagi na formaty kodu jest dla programisty tak samo ważne, jak zapewnienie jego działania. Nigdy nie możesz powiedzieć, kto będzie pracował nad Twoim kodem. Posiadanie łatwej do odczytania, dobrze zorganizowanej bazy kodu mówi o profesjonalnym programiście. Dzięki IntelliJ IDEA formatowanie kodu nie musi być tak trudne, jak napisanie samego kodu. Następnym razem, gdy będziesz pisać kod przy użyciu IntelliJ, skorzystaj z tych wskazówek. Ułatwi Ci to życie podczas debugowania kodu.