Memahami Kod Bersih: Nama Bermakna ⚡

Apabila menulis kod, salah satu aspek yang paling diabaikan lagi kritikal ialah penamaan.

Nama yang kami pilih untuk pembolehubah, fungsi, kelas dan entiti lain dalam kod kami boleh memberi kesan ketara kebolehbacaan, kebolehselenggaraan dan kualiti keseluruhan.

Bab 2 Kod Bersih menyelidiki seni dan sains memilih nama yang bermakna, menyediakan satu set garis panduan yang boleh membantu pembangun menulis kod yang ekspresif dan boleh difahami.

Dalam catatan blog ini, kami akan meneroka perkara penting daripada bab ini, menggambarkan setiap konsep dengan contoh dalam JavaScript.

?1. Gunakan Nama Yang Menzahirkan Niat

Nama yang anda pilih hendaklah menyampaikan maksud di sebalik pembolehubah, fungsi atau kelas dengan jelas. Pembaca seharusnya dapat memahami apa yang dilakukan oleh kod tanpa memerlukan konteks tambahan.

// Bad let d; // Good let daysUntilDeadline;

Dalam contoh pertama, d adalah kabur dan tidak memberikan konteks. Versi yang dipertingkatkan, daysUntilDeadline, dengan jelas menunjukkan perkara yang diwakili oleh pembolehubah.

?2. Elakkan maklumat yang salah

Nama tidak boleh mengelirukan. Elakkan menggunakan nama yang mungkin membayangkan makna yang berbeza daripada apa yang sebenarnya dilakukan oleh kod tersebut.

// Bad let accountList = new Map(); // Good let accountsMap = new Map();

Di sini, senarai akaun mungkin mengelirukan kerana ia mencadangkan senarai (yang merupakan koleksi tersusun), manakala struktur data sebenar ialah Peta. Menggunakan accountsMap adalah lebih tepat.

?3. Buat Perbezaan Bermakna

Jika anda perlu membezakan antara pembolehubah, fungsi atau kelas yang serupa, lakukan dengan cara yang menjadikan perbezaan itu jelas dan bermakna.

// Bad getUserInfo(); getUserData(); // Good getUserProfile(); getUserSettings();

Dalam contoh pertama, getUserInfo dan getUserData terlalu serupa dan tidak menyatakan perbezaannya dengan jelas. Contoh kedua menjelaskan perbezaan dengan menamakan fungsi berdasarkan perkara yang dikembalikan.

?4. Gunakan Nama yang Boleh Disebut

Nama hendaklah mudah dibaca dan disebut. Ini menjadikan perbincangan kod dengan orang lain lebih mudah.

// Bad let genymdhms; // Good let generationTimestamp;

genymdhms ialah nama yang tidak boleh disebut yang sukar untuk diingati atau dibincangkan. generationTimestamp, bagaimanapun, adalah jelas dan mudah untuk disebut.

?5. Gunakan Nama Boleh Dicari

Dalam pangkalan kod yang lebih besar, adalah penting untuk menggunakan nama yang mudah dicari. Elakkan menggunakan nama huruf tunggal atau nama yang terlalu singkatan.

// Bad let e = document.getElementById('email'); // Good let emailInputElement = document.getElementById('email');

e tidak mudah dicari dan ia tidak menyampaikan apa yang diwakilinya. emailInputElement adalah lebih deskriptif dan lebih mudah untuk dikesan dalam pangkalan kod.

?6. Elakkan Pengekodan

Elakkan memasukkan jenis, awalan atau pengekodan lain dalam nama anda. Biar nama itu sendiri cukup deskriptif.

// Bad let phoneString; // Good let phoneNumber;

Dalam kes ini, phoneString menyertakan pengekodan jenis yang tidak diperlukan (String). Nombor telefon adalah lebih ringkas dan lebih langsung.

?7. Nama Kelas Harus Kata Nama, Nama Fungsi Harus Kata Kerja

Kelas mewakili objek atau konsep, jadi nama mereka hendaklah kata nama. Fungsi, sebaliknya, mewakili tindakan, jadi nama mereka hendaklah kata kerja.

// Class names (Nouns) class UserAccount {} class ShoppingCart {} // Function names (Verbs) function calculateTotal() {} function sendEmail() {}

Perbezaan ini membantu dalam memahami peranan setiap elemen dalam kod anda.

?8. Elakkan Pemetaan Mental

Jangan paksa pembaca menterjemahkan nama kepada sesuatu yang lebih bermakna. Nama harus jelas.

// Bad let n = 5; // Number of users // Good let userCount = 5;

n memerlukan pembaca mengingati atau menyimpulkan bahawa ia bermaksud bilangan pengguna, manakala userCount serta-merta jelas.

Kesimpulan ⚡

Memilih nama yang bermakna bukan sekadar soal gaya—ia merupakan amalan asas dalam menulis kod yang bersih dan boleh diselenggara.

Dengan mengikuti garis panduan yang digariskan dalam Bab 2 Kod Bersih, anda boleh meningkatkan kebolehbacaan kod JavaScript anda dan memudahkan orang lain (dan anda sendiri) untuk memahami dan mengekalkan.

Ingat, matlamatnya adalah untuk menulis kod yang menyampaikan tujuan dan logiknya, mengurangkan beban kognitif pada pembaca.

Lain kali anda menamakan pembolehubah, fungsi atau kelas, pertimbangkan prinsip penamaan yang bermakna dan cara ia boleh menyumbang kepada kod yang lebih bersih dan berkesan.

Selamat Mengekod!

Atas ialah kandungan terperinci Memahami Kod Bersih: Nama Bermakna ⚡. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!