Cara Menulis Kod Bersih – Petua untuk Pembangun dengan Contoh

Bayangkan bilik yang sangat tidak kemas sehingga anda tidak dapat mencari kunci anda. Pakaian di mana-mana, buku bertimbun, dan huru-hara merajalela.

Sekarang bayangkan bekerja dalam kod yang tidak kemas.

Bencana yang SAMA, kecuali kini otak anda yang HILANG kewarasannya.


Kod bersih, sebaliknya, adalah seperti berjalan ke dalam bilik yang bersih. Semuanya betul-betul di tempat yang sepatutnya. Tiada tekanan. Tiada kekeliruan. Hanya kejelasan.

Inilah kebenarannya: menulis kod bersih BUKAN pilihan jika anda ingin berjaya dalam pembangunan perisian.

Anda boleh menulis kod yang tidak kemas dan jadi orang yang bergelut untuk membetulkan setiap pepijat, atau anda boleh menguasai kod bersih dan MENGUASAI setiap projek yang anda sentuh.

---

Pengekod Bersih lwn. Pengekod Kotor

Izinkan saya melukis gambar untuk anda.

Berikut ialah graf yang menunjukkan perjalanan dua jenis pengekod:

• ⚠️ Pengekod Buruk (Barisan Merah): Bermula dengan pantas tetapi rosak teruk. Lebih banyak baris yang mereka tulis, lebih banyak masalah yang mereka buat.
• ⚡ Kod Bersih (garisan Biru): Bermula perlahan tetapi kekal konsisten. Pertumbuhan tidak berhenti—ia semakin pantas.

Sekarang, anda tentukan baris mana yang ingin anda ikuti.

Kos Kod Buruk

Untuk menunjukkan carta ini, dalam fasa pembangunan awal, kod buruk adalah sedikit lebih mahal untuk ditukar daripada kod bersih.

Walau bagaimanapun, apabila kita beralih ke fasa penyelenggaraan dan pemfaktoran semula, jurang semakin meluas dengan KETARA, dengan kod buruk berkos hampir DUA KALI berbanding kod bersih.

Menjelang fasa warisan, kod buruk mencecah kos 100%, kini AMAT mahal untuk dikemas kini, manakala kod bersih kekal lebih terurus pada 45%.

Tidak syak lagi, kod buruk ialah masalah yang HARGA HARGA dalam pembangunan perisian.

---

10 Peraturan Kalis Peluru untuk Menulis Kod Bersih

1. Gunakan Nama Yang Bermakna Sesuatu

Menamakan pembolehubah atau fungsi anda b atau x adalah satu jenayah. Panggil mereka siapa mereka.

// Weak and vague
let b = 5;

// Strong and clear
let numberOfUsers = 5;

Orang yang menulis nama yang tidak jelas tidak mahu memiliki kesilapan mereka. Jangan jadi orang itu.

---

2. Keep Functions Laser-Fokus (SRP)

Sesuatu fungsi harus melakukan satu perkara—dan melakukannya dengan sempurna. Ini dipanggil Prinsip Tanggungjawab Tunggal (SRP).

Kod yang baik adalah seperti tukul. Ia terkena SATU paku, bukan sepuluh.

// Clean: One job, one focus
function calculateTotal(a, b) {
    return a + b;
}

function logTotal(user, total) {
    console.log(`User: ${user}, Total: ${total}`);
}

// Dirty: Trying to do EVERYTHING
function calculateAndLogTotal(a, b, user) {
    let total = a + b;
    console.log(`User: ${user}, Total: ${total}`);
}

Apabila anda mencampurkan tugas, anda campur KEKELIRUAN dengan bencana.

---

3. Berhenti Menggunakan Komen sebagai Tongkat

Anda jangan terangkan perkara yang dilakukan oleh pintu SETIAP kali seseorang masuk ke dalam bilik. Kod anda sepatutnya berfungsi dengan cara yang sama.

// Clean: Self-explanatory
let userAge = 25;

// Messy: Needs an explanation
let a; // This means "age of the user"

Ulasan tidak buruk, tetapi jika kod anda tidak dapat berdiri sendiri, anda telah pun gagal.

---

4. Jadikan Ia Boleh Dibaca

Jika seseorang membaca kod anda berasa seperti mereka sedang menyelesaikan teka-teki, anda SUDAH menjadi pengacau.

// Clean: Reads like a story
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Messy: Feels like chaos
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

Kod boleh dibaca bukan hanya untuk orang lain—ia untuk anda enam bulan dari sekarang.

---

5. Uji Semua yang Anda Tulis

Jika anda terlalu malas untuk menulis ujian, JANGAN merungut apabila kod anda rosak.

class Calculator {
    add(a, b) { return a + b; }
    subtract(a, b) { return a - b; }
}

// Test it (Unit Test)
const calculator = new Calculator();
console.assert(calculator.add(2, 3) === 5, "Addition failed");
console.assert(calculator.subtract(5, 3) === 2, "Subtraction failed");

Ujian ialah polisi insurans anda. Abaikan mereka dan anda berjudi dengan masa anda.

---

6. Berhati-hati dengan Kebergantungan

Pergantungan adalah seperti TAWARAN. Dapatkan yang BETUL, dan anda MENANG. Pilih dengan teruk, dan anda terkunci kepada sesuatu yang anda akan menyesal.

// Dependency: Sending emails with Nodemailer
const nodemailer = require('nodemailer');
function sendEmail(to, subject, message) {
    const transporter = nodemailer.createTransport({ /* config */ });
    return transporter.sendMail({ from: "you@example.com", to, subject, text: message });
}

Elakkan kebergantungan pengekodan keras. Gunakan abstraksi atau fail konfigurasi untuk penyelenggaraan yang selamat.

Ini hanyalah satu contoh. Sebagai pembangun, anda boleh menggunakan RATUSAN perpustakaan atau tanggungan.

Saya tidak mengatakan anda tidak perlu bergantung pada mereka, pada masa kini sukar untuk mengelakkannya. Tetapi anda harus berhati-hati SEBELUM memasangnya dalam projek pengekodan anda.

Anda harus menyemak keselamatan, prestasi, kualiti atau kefungsian sistem perisian organisasi. Kerana ia kadangkala mengandungi risiko yang boleh merosakkan KESELURUHAN projek anda.

Sentiasa KAWAL alatan anda, jangan biarkan mereka mengawal ANDA.

---

7. Susun Projek Seperti Bos

Projek yang teratur ialah perbezaan antara jualan garaj dan mewah butik.

myProject
├── src
│   ├── components
│   ├── services
│   ├── utils
└── tests

Berikut ialah cara SETIAP folder harus disusun untuk projek ini:

Jika pangkalan kod anda kelihatan seperti laci sampah, anda sudah kehilangan rasa hormat diri masa depan anda.

Struktur Projek Pepejal Apl E-mel:
Katakan anda sedang membina aplikasi yang menghantar e-mel kepada pengguna. Struktur projek SOLID yang tidak dapat dipecahkan seperti bos anda sepatutnya kelihatan seperti ini:

---

8. Konsisten dengan Memformat

Jangan kod seperti orang yang mempunyai 10 personaliti. Selaras dengan pemformatan anda.

Gunakan alatan seperti Prettier atau ESLint untuk menguatkuasakan gaya KONSISTEN anda. Jika setiap fail kelihatan berbeza, anda sedang mencipta huru-hara yang TIADA SIAPA mahu membetulkan.

Saya akan katakan, konsistensi dalam pemformatan ialah prinsip asas kod bersih kerana ia menjamin kebolehbacaan.

Sila lihat...

Gunakan 2 atau 4 ruang untuk lekukan secara konsisten di seluruh pangkalan kod anda. Elakkan tab untuk mengekalkan keseragaman merentas editor yang berbeza.

Kekalkan baris pada maksimum 100-120 aksara untuk mengelakkan menatal mendatar dan meningkatkan kebolehbacaan.

Logik berkaitan kumpulan bersama dan asingkan blok kod dengan garis kosong untuk serlahkan tujuannya.

Akhir sekali, elakkan kod penjajaran berlebihan; sebaliknya, biarkan lekukan secara semula jadi membimbing aliran logik.

---

9. Hentikan Nilai Pengekodan Keras

Pengekodan keras adalah kemalasan yang menyamar sebagai usaha. Sila lihat:

// Weak and vague
let b = 5;

// Strong and clear
let numberOfUsers = 5;

Jadi, pengekodan keras ialah jalan pintas yang membawa anda keluar dari jurang.

---

10. Pastikan Fungsi Singkat

Jika fungsi anda lebih daripada 20 baris, ia mungkin cuba melakukan terlalu banyak. Pecahkan.

// Clean: One job, one focus
function calculateTotal(a, b) {
    return a + b;
}

function logTotal(user, total) {
    console.log(`User: ${user}, Total: ${total}`);
}

// Dirty: Trying to do EVERYTHING
function calculateAndLogTotal(a, b, user) {
    let total = a + b;
    console.log(`User: ${user}, Total: ${total}`);
}

Fungsi pendek ialah fungsi tajam. Mereka mencapai markah mereka SETIAP kali.

---

??Hadiah Krismas!

SESIAPA sahaja boleh menulis kod yang tidak kemas. Malah AI boleh membuang sampah.

Tetapi menulis kod bersih? Itulah kemahiran yang memisahkan amatur daripada pengaturcara profesional.

Anda mahu menguasai pembangunan perisian? Tulis kod bersih. Mudah sahaja.

Bagaimana untuk menulis kod bersih kemudian?

Izinkan saya memberitahu anda sesuatu—apa yang baru anda baca dalam artikel ini TIDAK lebih daripada titisan dari lautan pengetahuan dalam buku saya, Kod Bersih Sifar kepada Satu.

10 peraturan ini? Mereka hanya PERMUKAAN.

Buku ini menggali jauh ke dalam SETIAP prinsip, SETIAP peraturan, dan SETIAP teknik, diterangkan dengan cara yang begitu jelas dan terperinci sehingga anda TIDAK AKAN melupakannya.

Saya telah membungkusnya dengan ribuan ilustrasi digital dan senario dunia sebenar yang bukan sahaja mengajar anda—ia menarik anda ke dunia pengekodan yang bersih seperti anda pernah nampak.

Hakikatnya ialah: pengekod yang tidak kemas jangan SURVIVE. Mereka tenggelam dalam kekacauan mereka sendiri. Pengekod bersih MENGUASAI. Mereka menulis perisian yang tahan ujian masa, dan mereka TIDAK PERNAH bergelut dengan pepijat yang tidak dapat diperbaiki atau ciri yang TIDAK BOLEH ditambah.

Jika anda SERIUS untuk menunjukkan CARA anda menulis kod, buku ini bukan pilihan—ia adalah mesti ada.

Dan kerana hari ini Krismas, saya memudahkan anda. Gunakan kod promosi MERRYCHRISTMAS untuk mendapatkan diskaun 50%.

Tetapi jangan tunggu terlalu lama—tawaran ini tamat 31 Disember 2024.

Klik pautan di bawah, dapatkan buku itu.

? Dapatkan Kod Bersih Zero to One Sekarang

Pilihan di tangan anda. Anda boleh terus menulis kod yang tidak kemas, membuang masa dan tenaga, atau anda boleh MENGAMBIL KAWALAN, belajar MENGUASAI projek anda dan MEMBINA perisian seperti BOSS.

? Ikuti saya untuk maklumat lanjut: @shahancd
? Surat Berita Mingguan Saya: Horscoder

---

Baca lebih lanjut: menulis komponen yang bersih dan boleh diguna semula dalam React

Atas ialah kandungan terperinci Cara Menulis Kod Bersih – Petua untuk Pembangun dengan Contoh. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!