Coffee break #86. Panduan Cepat dan Mudah untuk Memformat Semula Kod dalam IntelliJ IDEA

Sumber: Lightrun Sebagai pembangun, anda perlu membuat perubahan pada pangkalan kod. Dan jika asas kod tidak diformat dengan jelas, maka penyahpepijatan akan menjadi lebih sukar untuk anda. Perubahan kecil seperti pemformatan semula dan lekukan yang betul dalam kod biasanya diabaikan, tetapi ia jelas membantu membezakan pangkalan kod pembangun profesional daripada pangkalan kod pemula. Mengekalkan pemformatan dan lekukan kod yang betul akan membantu anda menulis kod yang lebih mudah dibaca. Ini memudahkan kerjasama dalam projek, meningkatkan kelajuan penyahpepijatan dan mengekalkan asas kod. Kod menjadi lebih mudah dibaca dan berstruktur. Adakah mungkin untuk mempercepatkan proses pemformatan semula kod? Artikel ini akan memperkenalkan anda kepada kaedah mudah untuk memformat semula kod secara automatik menggunakan IntelliJ IDEA. Anda akan belajar cara mengurangkan masa yang diperlukan untuk prosedur ini dan anda juga akan belajar cara mengecualikan bahagian pangkalan kod daripada memformat semula menggunakan pelbagai pintasan papan kekunci.

Faedah memformat semula

Adalah penting untuk diingat bahawa tiada kod pemformatan atau ulasan diperlukan untuk fungsi itu berfungsi. Sebarang kod, dengan atau tanpa pemformatan, boleh dibaca dan dilaksanakan sepenuhnya oleh pengkompil. Sebaliknya, pemformatan semula menjadikan markup lebih mudah dibaca oleh orang ramai. Untuk pengkompil, apa yang penting ialah kod itu berfungsi dan ia tidak mengandungi ralat, dan bukannya seberapa baik ia atau seberapa baik inden itu. Benar, ia adalah yang terakhir yang membimbangkan orang, kerana mereka perlu membaca kod sedemikian. Sama seperti teks biasa, tiada siapa yang suka membaca kandungan tanpa bentuk tanpa tajuk, perenggan atau sebarang lekukan. Beberapa teknik pemformatan semula yang diperlukan termasuk:

• Inden.
• Gaya dan fungsi penulisan.
• Ruang kosong.
• Penggunaan huruf besar dan nama.

Nyahpepijat adalah kejahatan yang perlu yang sering dihadapi oleh pembangun sepanjang kerjaya mereka. Di mana hendak bermula jika pangkalan kod anda berselerak dan tidak teratur? Apabila kod sumber diformat dan diinden dengan betul, ia kelihatan kurang berkelompok. Ini memudahkan untuk menentukan di mana modul aplikasi yang berbeza berada. Akibatnya, ia menjadi lebih mudah untuk mencari masalah dan kesilapan. Pemformatan semula kod dalam IntelliJ IDEA adalah berdasarkan keperluan yang dinyatakan dalam tetapan gaya kod dalam IDE. Walaupun, apabila anda menggunakan EditorConfig dalam projek anda, tetapan yang anda tentukan dalam fail .editorconfig akan secara lalai mengatasi tetapan yang dinyatakan dalam tetapan gaya kod. Pemformatan semula dalam IntelliJ tidak berbeza daripada bekerja dalam IDE lain. Terdapat pilihan untuk memformat semula satu blok kod dan keseluruhan fail. Mungkin ada kalanya keseluruhan blok kod anda agak panjang dan anda mahu semuanya diformatkan semula kecuali untuk beberapa kawasan tertentu. Dalam kes ini, memilih bahagian kod yang ingin anda formatkan secara individu bukanlah pilihan terbaik. Dalam situasi sedemikian, pemformatan semula dengan IntelliJ pasti akan berguna. Kami akan meneroka ini dan kegunaan lain IDE.

Petua untuk memformat kod

Mari lihat beberapa petua asas untuk memformat kod secara umum:

• Pastikan kod anda diulas dengan betul. Gunakan komen untuk menyampaikan maksud dan maksud. Walaupun anda seorang sahaja yang membaca kod ini, ia masih berguna untuk mengingatkan diri anda tentang tujuan blok kod tertentu. Ini akan menjadikan perkara lebih mudah jika anda kembali ke pangkalan kod anda selepas bercuti, contohnya.

• Jangan gunakan tab untuk ruang pada baris yang sama. Ini mengurangkan kebolehbacaan kod.

• Tambahkan TODO pada blok kod anda untuk menjejaki pelaksanaan masa hadapan. Dengan cara ini, apabila anda memformat semula kod anda, ia tidak akan mewujudkan ilusi bahawa kerja anda telah selesai.

• Jangan gunakan pemformatan semula kod sebagai penyelesaian pantas untuk ralat sintaks.

• Elakkan pelaburan yang mendalam. Ini adalah amalan biasa di kalangan sesetengah pembangun, tetapi kod bersarang dalam menjadikannya sukar untuk dibaca dan memperkenalkan ralat yang tidak mudah dikesan pada pandangan pertama.

Memformat semula kod dalam IntelliJ IDEA

Sebelum kita meneroka cara yang berbeza untuk memformat kod dalam IntelliJ, mulakan dengan mencipta contoh projek Java dalam IDE anda. Sebaik sahaja anda melancarkan IntelliJ, anda akan melihat skrin seperti ini: Klik Seterusnya dan lengkapkan persediaan permulaan projek. Setelah projek anda disediakan, tiba masanya untuk menambah kod sampel untuk membantu anda memahami pemformatan semula kod dalam IntelliJ. Ini adalah pembilang perkataan mudah dari Universiti 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 semula coretan kod

Mari mulakan dengan memformatkan coretan kod. Untuk melakukan ini, cuma serlahkan bahagian kod yang ingin anda formatkan dan klik Kod > Format Semula Kod . Seperti yang anda lihat, bahagian kod anda yang diserlahkan (dalam kes ini baris 11-17) diformatkan dengan betul. Mari lihat "sebelum" dan "selepas" memformat semula coretan kod kami. Jika anda perhatikan dalam imej pertama, pengisytiharan dan permulaan pembolehubah anda berlaku pada baris yang sama seperti try . Pendakap kerinting penutup bercampur dengan blok lain . Tetapi selepas menyerlahkan bahagian kod anda ini dan menggunakan pilihan pemformatan semula, anda akan mendapat blok kod yang lebih menyenangkan mata. Kod lengkap untuk kelas anda kini kelihatan seperti ini: Perhatikan bahawa hanya blok kod yang anda pilih telah diformatkan semula.

Memformat semula keseluruhan fail

Untuk memformat semula keseluruhan fail, buka editor, letakkan kursor di mana-mana sahaja dan klik Kod >Reformat Fail . Anda akan digesa untuk memilih pilihan pemformatan semula yang sesuai untuk keseluruhan fail. Tindakan ini akan memformat semula semua kod anda dalam editor aktif. Kod anda akan menjadi seperti ini:

Memformat semula modul atau direktori

Untuk melakukan ini, semua yang anda perlu lakukan ialah klik kanan modul dalam tetingkap alatan projek dan pilih Reformat Code . Dalam tetingkap pop timbul, pilih mana-mana daripada tiga pilihan yang anda perlukan:

• Optimumkan Import : Pilih pilihan ini jika anda ingin menambah penyata import yang hilang dan juga menyingkirkan import yang tidak digunakan.

• Susun Semula Entri : Untuk menyusun semula kod mengikut peraturan susun atur yang dinyatakan dalam tetapan gaya kod.

• Kod pembersihan : untuk menjalankan pembersihan kod.

Apabila anda selesai, cuma klik OK.

Tidak termasuk kod daripada pemformatan semula

Mari lihat apa yang perlu dilakukan jika anda mempunyai blok kod yang anda tidak mahu sertakan semasa memformat keseluruhan fail. Pergi ke Fail > Tetapan atau gunakan pintasan papan kekunci Ctrl + Alt + S. Pergi ke Editor > Gaya Kod dan semak Dayakan penanda pemformat dalam menu ulasan pada tab Kawalan Pemformat . Dalam editor anda, buat ulasan baris dan taip //@formatter:off tanpa petikan pada permulaan kawasan yang ingin anda kecualikan. Di penghujung kawasan, buat ulasan baris lain dan masukkan //@formatter:on , juga tanpa petikan. Dalam imej di atas, anda dapat melihat bahawa pemformat akan mengabaikan kod anda pada baris 23 hanya kerana anda menyatakannya dalam ulasan dan pengawal format.

Contoh hotkey untuk memformat semula

• Format semula blok kod: Ctrl + Alt + Shift + L
• Format semula fail: Ctrl + Alt + L
• Tambahkan ulasan pada baris: Ctrl + /
• Tambah ulasan blok: Ctrl + Shift + /

Kesimpulan

Memberi perhatian kepada format kod adalah sama pentingnya untuk pembangun dengan menjadikannya berfungsi. Anda tidak boleh memberitahu siapa yang akan bekerja pada kod anda. Mempunyai asas kod yang mudah dibaca dan tersusun dengan baik bercakap tentang pembangun profesional. Dengan IntelliJ IDEA, memformat kod anda tidak perlu sesukar menulis kod itu sendiri. Lain kali anda menulis kod menggunakan IntelliJ, gunakan petua ini. Ini akan menjadikan hidup anda lebih mudah apabila menyahpepijat kod anda.