Ngopi #86. Pandhuan Cepet lan Gampang kanggo ngowahi format kode ing IntelliJ IDEA

Sumber: Lightrun Minangka pangembang, sampeyan kudu nggawe pangowahan ing basis kode. Lan yen basis kode ora diformat kanthi jelas, debugging bakal dadi luwih angel kanggo sampeyan. Owah-owahan cilik kaya reformatting lan indentasi sing tepat ing kode biasane diabaikan, nanging kanthi temenan mbantu mbedakake basis kode pangembang profesional saka basis kode pamula. Njaga format kode lan indentasi sing bener bakal mbantu sampeyan nulis kode sing luwih gampang diwaca. Iki nyederhanakake kolaborasi ing proyek, nambah kacepetan debugging lan njaga basis kode. Kode dadi luwih bisa diwaca lan kabentuk. Apa bisa nyepetake proses ngowahi format kode? Artikel iki bakal ngenalake sampeyan cara prasaja kanggo ngowahi format kode kanthi otomatis nggunakake IntelliJ IDEA. Sampeyan bakal sinau carane nyuda wektu sing dibutuhake kanggo prosedur iki, lan sampeyan uga bakal sinau carane ngilangi bagean saka basis kode saka ngowahi format nggunakake macem-macem trabasan keyboard.

Keuntungan saka reformatting

Penting kanggo elinga yen ora ana kode format utawa komentar sing dibutuhake supaya fungsi kasebut bisa digunakake. Kode apa wae, nganggo utawa tanpa format, bisa diwaca lan dieksekusi kanthi lengkap dening kompiler. Ing sisih liya, ngowahi format nggawe markup luwih gampang diwaca wong. Kanggo compiler, kabeh sing penting yaiku kode kasebut bisa digunakake lan ora ngemot kesalahan, lan ora kepiye carane apik utawa apik banget. Bener, sing terakhir sing kuwatir wong, amarga kudu maca kode kasebut. Kaya teks biasa, ora ana sing seneng maca konten tanpa wujud tanpa judhul, paragraf, utawa lekukan apa wae. Sawetara teknik reformatting sing dibutuhake kalebu:

• Indent.
• Gaya lan fungsi nulis.
• papan kosong.
• Panganggone huruf kapital lan jeneng.

Debugging minangka piala sing kudu ditindakake dening pangembang sajrone karire. Ngendi kudu diwiwiti yen basis kode sampeyan rame lan ora teratur? Nalika kode sumber wis bener format lan indented, katon kurang clustered. Iki nggawe luwih gampang kanggo nemtokake lokasi modul aplikasi sing beda-beda. Akibate, dadi luwih gampang nemokake masalah lan kesalahan. Kode reformatting ing IntelliJ IDEA adhedhasar syarat kasebut ing setelan gaya kode ing IDE. Sanajan, nalika sampeyan nggunakake EditorConfig ing proyek sampeyan, setelan sing sampeyan nemtokake ing file .editorconfig kanthi standar bakal ngilangi sing kasebut ing setelan gaya kode. Reformatting ing IntelliJ ora beda karo nggarap IDE liyane. Ana opsi kanggo ngowahi format siji blok kode lan kabeh file. Bisa uga ana wektu nalika blok kode sampeyan cukup dawa lan sampeyan pengin kabeh diformat maneh kajaba sawetara wilayah tartamtu. Ing kasus iki, milih bagean kode sing pengin diformat kanthi individu ora dadi pilihan sing paling apik. Ing kahanan kaya mengkono, ngowahi format karo IntelliJ mesthi bakal migunani. Kita bakal njelajah iki lan panggunaan IDE liyane.

Tips kanggo kode format

Ayo goleki sawetara tips dhasar kanggo format kode ing umum:

• Priksa manawa kode sampeyan wis dikomentari kanthi bener. Gunakake komentar kanggo nerangake maksud lan makna. Sanajan sampeyan mung maca kode iki, isih migunani kanggo ngelingake dhewe babagan tujuan blok kode tartamtu. Iki bakal luwih gampang yen sampeyan bali menyang basis kode sawise preian, contone.

• Aja nggunakake tab kanggo spasi ing baris sing padha. Iki nyuda readability saka kode.

• Tambah TODO menyang blok kode kanggo nglacak implementasine ing mangsa ngarep. Kanthi cara iki, nalika sampeyan ngowahi format kode sampeyan, ora bakal nggawe khayalan yen karya sampeyan wis rampung.

• Aja nggunakake kode reformatting minangka fix cepet kanggo kesalahan sintaks.

• Ngindhari investasi jero. Iki minangka praktik umum ing sawetara pangembang, nanging kode sing disambungake kanthi jero nggawe angel diwaca lan ngenalake kesalahan sing ora gampang ditemokake nalika sepisanan.

Kode format maneh ing IntelliJ IDEA

Sadurunge njelajah macem-macem cara kanggo ngowahi format kode ing IntelliJ, miwiti nggawe conto proyek Java ing IDE sampeyan. Sawise sampeyan miwiti IntelliJ, sampeyan kudu ndeleng layar kaya iki: Klik Sabanjure lan ngrampungake persiyapan initialization project. Saiki proyek sampeyan wis disiyapake, wektune nambahake kode sampel kanggo mbantu sampeyan ngerti format ulang kode ing IntelliJ. Iki minangka counter tembung prasaja saka Universitas 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.");
        }
    }
}

Reformating kode potongan

Ayo miwiti kanthi ngowahi format potongan kode. Kanggo nindakake iki, cukup nyorot bagean kode sing pengin diformat banjur klik Kode > Reformat Kode . Kaya sing sampeyan ngerteni, bagean kode sing disorot (ing kasus iki baris 11-17) diformat kanthi bener. Ayo ndeleng "sadurunge" lan "sawise" ngowahi format potongan kode kita. Yen sampeyan ngelingi ing gambar pisanan, deklarasi lan inisialisasi variabel sampeyan kedadeyan ing baris sing padha karo try . Kurung kriting tutup dicampur karo blok liyane . Nanging sawise nyorot bagean kode iki lan nggunakake opsi reformatting, sampeyan bakal entuk blok kode sing luwih nyenengake kanggo mripat. Kode lengkap kanggo kelas sampeyan saiki katon kaya iki: Elinga yen mung blok kode sing sampeyan pilih wis diformat maneh.

Reformating kabeh file

Kanggo ngowahi format kabeh file, bukak editor, selehake kursor ing ngendi wae banjur klik Kode >Reformat File . Sampeyan bakal dijaluk milih opsi reformatting sing cocog kanggo kabeh file. Tindakan iki bakal ngowahi format kabeh kode sampeyan ing editor aktif. Kode sampeyan bakal dadi kaya iki:

Ngowahi format modul utawa direktori

Kanggo nindakake iki, sampeyan mung kudu klik-tengen modul ing jendela alat proyek banjur pilih Reformat Kode . Ing jendhela pop-up, pilih salah siji saka telung opsi sing dibutuhake:

• Ngoptimalake Impor : Pilih opsi iki yen sampeyan pengin nambah statement ngimpor ilang lan uga njaluk nyisihaken saka impor sing ora digunakake.

• Ngatur maneh Entri : Kanggo ngatur maneh kode miturut aturan tata letak sing ditemtokake ing setelan gaya kode.

• Kode reresik : kanggo mbukak kode reresik.

Yen wis rampung, mung klik OK.

Ora kalebu kode saka reformatting

Ayo goleki apa sing kudu ditindakake yen sampeyan duwe blok kode sing ora pengin dilebokake nalika ngowahi format kabeh file. Pindhah menyang File > Setelan utawa gunakake trabasan keyboard Ctrl + Alt + S. Pindhah menyang Editor > Gaya Kode lan priksa Aktifake panandha format ing menu komentar ing tab Kontrol Formatter . Ing editor sampeyan, gawe komentar baris lan ketik //@formatter:off tanpa tanda kutip ing wiwitan area sing pengin diilangi. Ing mburi wilayah, nggawe komentar baris liyane lan ketik //@formatter:on , uga tanpa kuotasi. Ing gambar ing ndhuwur, sampeyan bisa ndeleng manawa formatter bakal nglirwakake kode sampeyan ing baris 23 mung amarga sampeyan nemtokake ing komentar lan pengontrol format.

Conto hotkeys kanggo reformatting

• Format maneh blok kode: Ctrl + Alt + Shift + L
• Reformat file: Ctrl + Alt + L
• Tambah komentar menyang baris: Ctrl + /
• Tambah komentar blok: Ctrl + Shift + /

Kesimpulan

Mbayar manungsa waé kanggo format kode mung minangka penting kanggo pangembang minangka nggawe iku bisa. Sampeyan ora bisa ngomong sapa sing bakal nggarap kode sampeyan. Duwe basis kode sing gampang diwaca lan terstruktur kanthi apik ngomong babagan pangembang profesional. Kanthi IntelliJ IDEA, format kode sampeyan ora kudu angel kaya nulis kode kasebut dhewe. Sabanjure sampeyan nulis kode nggunakake IntelliJ, gunakake tips iki. Iki bakal nggawe urip luwih gampang nalika debugging kode.