Rehat kopi #86. Panduan Cepat dan Mudah untuk Memformat Ulang Kode di IntelliJ IDEA

Sumber: Lightrun Sebagai pengembang, Anda harus melakukan perubahan pada basis kode. Dan jika basis kode tidak diformat dengan jelas, proses debug akan menjadi lebih sulit bagi Anda. Perubahan kecil seperti pemformatan ulang dan lekukan yang tepat dalam kode biasanya diabaikan, namun perubahan tersebut jelas membantu membedakan basis kode pengembang profesional dari basis kode pemula. Mempertahankan format dan indentasi kode yang tepat akan membantu Anda menulis kode yang lebih mudah dibaca. Ini menyederhanakan kolaborasi proyek, meningkatkan kecepatan debugging dan memelihara basis kode. Kode menjadi lebih mudah dibaca dan terstruktur. Apakah mungkin untuk mempercepat proses pemformatan ulang kode? Artikel ini akan memperkenalkan Anda pada metode sederhana untuk memformat ulang kode secara otomatis menggunakan IntelliJ IDEA. Anda akan mempelajari cara mengurangi waktu yang diperlukan untuk prosedur ini, dan Anda juga akan mempelajari cara mengecualikan bagian basis kode dari pemformatan ulang menggunakan berbagai pintasan keyboard.

Manfaat memformat ulang

Penting untuk diingat bahwa tidak diperlukan kode pemformatan atau komentar agar fungsi dapat berfungsi. Kode apa pun, dengan atau tanpa pemformatan, dapat dibaca dan dijalankan sepenuhnya oleh kompiler. Di sisi lain, memformat ulang membuat markup lebih mudah dibaca orang. Bagi compiler, yang terpenting adalah kodenya berfungsi dan tidak mengandung kesalahan, dan bukan seberapa bagus atau seberapa bagus indentasinya. Benar, yang terakhir inilah yang membuat orang khawatir, karena mereka harus membaca kode tersebut. Sama seperti teks biasa, tidak ada orang yang suka membaca konten tanpa bentuk tanpa judul, paragraf, atau lekukan apa pun. Beberapa teknik pemformatan ulang yang diperlukan meliputi:

• Indentasi.
• Gaya dan fungsi penulisan.
• Ruang kosong.
• Penggunaan huruf kapital dan nama.

Debugging adalah kejahatan penting yang sering ditemui pengembang sepanjang karier mereka. Di mana harus memulai jika basis kode Anda berantakan dan tidak terorganisir? Ketika kode sumber diformat dan diindentasi dengan benar, kode sumber akan tampak kurang terkelompok. Hal ini memudahkan untuk menentukan di mana berbagai modul aplikasi berada. Akibatnya, lebih mudah menemukan masalah dan kesalahan. Pemformatan ulang kode di IntelliJ IDEA didasarkan pada persyaratan yang ditentukan dalam pengaturan gaya kode di IDE. Meskipun, ketika Anda menggunakan EditorConfig dalam proyek Anda, pengaturan yang Anda tentukan dalam file .editorconfig secara default akan menggantikan pengaturan yang ditentukan dalam pengaturan gaya kode. Memformat ulang di IntelliJ tidak berbeda dengan bekerja di IDE lain. Ada opsi untuk memformat ulang satu blok kode dan seluruh file. Mungkin ada saatnya seluruh blok kode Anda cukup panjang dan Anda ingin semuanya diformat ulang kecuali beberapa area tertentu. Dalam hal ini, memilih bagian kode yang ingin Anda format satu per satu jelas bukan pilihan terbaik. Dalam situasi seperti itu, memformat ulang dengan IntelliJ pasti akan berguna. Kami akan mengeksplorasi hal ini dan kegunaan IDE lainnya.

Tip untuk memformat kode

Mari kita lihat beberapa tip dasar untuk memformat kode secara umum:

• Pastikan kode Anda dikomentari dengan benar. Gunakan komentar untuk menyampaikan maksud dan makna. Bahkan jika Anda satu-satunya yang membaca kode ini, ada gunanya mengingatkan diri Anda sendiri tentang tujuan blok kode tertentu. Ini akan mempermudah jika Anda kembali ke basis kode setelah liburan, misalnya.

• Jangan gunakan tab untuk spasi pada baris yang sama. Hal ini mengurangi keterbacaan kode.

• Tambahkan TODO ke blok kode Anda untuk melacak penerapan di masa mendatang. Dengan cara ini, saat Anda memformat ulang kode, tidak akan tercipta ilusi bahwa pekerjaan Anda telah selesai.

• Jangan gunakan pemformatan ulang kode sebagai perbaikan cepat untuk kesalahan sintaksis.

• Hindari investasi yang mendalam. Ini adalah praktik umum di antara beberapa pengembang, tetapi kode yang sangat bertumpuk membuatnya sulit dibaca dan menimbulkan kesalahan yang tidak mudah dikenali pada pandangan pertama.

Memformat ulang kode di IntelliJ IDEA

Sebelum kita menjelajahi berbagai cara untuk memformat kode di IntelliJ, mulailah dengan membuat contoh proyek Java di IDE Anda. Setelah Anda meluncurkan IntelliJ, Anda akan melihat layar seperti ini: Klik Berikutnya dan selesaikan pengaturan inisialisasi proyek. Sekarang proyek Anda sudah siap, saatnya menambahkan kode contoh untuk membantu Anda memahami pemformatan ulang kode di IntelliJ. Ini adalah penghitung kata sederhana dari 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.");
        }
    }
}

Memformat ulang cuplikan kode

Mari kita mulai dengan memformat cuplikan kode. Untuk melakukan ini, cukup sorot bagian kode yang ingin Anda format dan klik Kode > Format Ulang Kode . Seperti yang Anda lihat, bagian kode Anda yang disorot (dalam hal ini baris 11-17) diformat dengan benar. Mari kita lihat “sebelum” dan “sesudah” memformat ulang cuplikan kode kita. Jika Anda perhatikan pada gambar pertama, deklarasi dan inisialisasi variabel Anda terjadi pada baris yang sama dengan try . Tanda kurung kurawal penutup dicampur dengan blok else . Namun setelah menyorot bagian kode ini dan menggunakan opsi pemformatan ulang, Anda akan mendapatkan blok kode yang lebih enak dipandang. Kode lengkap untuk kelas Anda sekarang terlihat seperti ini: Perhatikan bahwa hanya blok kode yang Anda pilih yang telah diformat ulang.

Memformat ulang seluruh file

Untuk memformat ulang seluruh file, buka editor, tempatkan kursor di mana saja dan klik Kode > Format Ulang File . Anda akan diminta untuk memilih opsi pemformatan ulang yang sesuai untuk seluruh file. Tindakan ini akan memformat ulang semua kode Anda di editor aktif. Kode Anda akan menjadi seperti ini:

Memformat ulang modul atau direktori

Untuk melakukan ini, yang perlu Anda lakukan hanyalah klik kanan modul di jendela alat proyek dan pilih Reformat Code . Di jendela pop-up, pilih salah satu dari tiga opsi yang Anda perlukan:

• Optimalkan Impor : Pilih opsi ini jika Anda ingin menambahkan pernyataan impor yang hilang dan juga membuang impor yang tidak digunakan.

• Menyusun Ulang Entri : Untuk mengatur ulang kode sesuai dengan aturan tata letak yang ditentukan dalam pengaturan gaya kode.

• Kode pembersihan : untuk menjalankan pembersihan kode.

Jika sudah selesai, klik saja OK.

Tidak termasuk kode dari pemformatan ulang

Mari kita lihat apa yang harus dilakukan jika Anda memiliki blok kode yang tidak ingin Anda sertakan saat memformat seluruh file. Buka File > Pengaturan atau gunakan pintasan keyboard Ctrl + Alt + S. Buka Editor > Gaya Kode dan centang Aktifkan penanda formatter di menu komentar pada tab Kontrol Formatter . Di editor Anda, buat baris komentar dan ketik //@formatter:off tanpa tanda kutip di awal area yang ingin Anda kecualikan. Di akhir area, buat baris komentar lain dan masukkan //@formatter:on , juga tanpa tanda kutip. Pada gambar di atas, Anda dapat melihat bahwa pemformat akan mengabaikan kode Anda pada baris 23 hanya karena Anda menentukannya di komentar dan pengontrol format.

Contoh hotkey untuk memformat ulang

• Format ulang blok kode: Ctrl + Alt + Shift + L
• Format ulang file: Ctrl + Alt + L
• Tambahkan komentar ke baris: Ctrl + /
• Tambahkan komentar blok: Ctrl + Shift + /

Kesimpulan

Memperhatikan format kode sama pentingnya bagi pengembang dengan membuatnya berfungsi. Anda tidak pernah tahu siapa yang akan mengerjakan kode Anda. Memiliki basis kode yang mudah dibaca dan terstruktur dengan baik menunjukkan seorang pengembang profesional. Dengan IntelliJ IDEA, memformat kode Anda tidak sesulit menulis kode itu sendiri. Lain kali Anda menulis kode menggunakan IntelliJ, gunakan tips berikut. Ini akan membuat hidup Anda lebih mudah saat men-debug kode Anda.