Amalan Terbaik untuk Menulis Kod JavaScript yang Bersih dan Boleh Diselenggara

1. Pembolehubah Bermakna dan Nama Fungsi:
Petua: Gunakan nama deskriptif yang menunjukkan dengan jelas tujuan pembolehubah atau fungsi.
Contoh:

Copy code
// Bad
const x = calculate(5);

// Good
const totalPrice = calculatePrice(5);

2. Komen Deskriptif:
Petua: Tulis ulasan ringkas tetapi bermakna untuk menerangkan logik atau niat yang kompleks. Komen harus menjelaskan mengapa sesuatu dilakukan, bukan perkara yang sedang dilakukan (yang sepatutnya jelas daripada kod itu sendiri).
Contoh:

// Bad
// Loops through the array
array.forEach(item => doSomething(item));

// Good
// Process each item to filter out non-active users
array.forEach(item => filterActiveUsers(item));

3. Prinsip Tanggungjawab Tunggal:
Petua: Pastikan fungsi dan kaedah melaksanakan satu tugas tertentu, menjadikannya boleh digunakan semula dan mudah untuk nyahpepijat.
Contoh:

// Bad
function handleUserLoginAndDisplayUserProfile() { /* multiple tasks */ }

// Good
function handleUserLogin() { /* one task */ }
function displayUserProfile() { /* one task */ }

4. Pemformatan dan Gaya Konsisten:
Petua: Gunakan pemformatan kod yang konsisten (lekukan, ruang) dan ikut garis panduan gaya (camelCase untuk pembolehubah, PascalCase untuk kelas, dll.).
Contoh:

js
Copy code
// Bad
function fetchData(){return 'data'}

// Good
function fetchData() {
  return 'data';
}

5. Elakkan Nombor Ajaib dan Rentetan:
Petua: Gunakan pemalar bernama dan bukannya nombor pengekodan keras atau rentetan, yang menjadikan kod anda lebih mudah dibaca dan diselenggara.
Contoh:

// Bad
const discount = total * 0.1;

// Good
const DISCOUNT_RATE = 0.1;
const discount = total * DISCOUNT_RATE;

6. Tulis Kod Modular:
Petua: Pecahkan kod anda kepada modul atau fungsi yang lebih kecil dan boleh digunakan semula. Ini meningkatkan kebolehgunaan semula dan kebolehselenggaraan.
Contoh:

// Bad
function processOrder(order) { /* many tasks */ }

// Good
function validateOrder(order) { /* one task */ }
function calculateTotal(order) { /* one task */ }

7. Gunakan Pengendalian Ralat Bermakna:
Petua: Tangkap dan kendalikan ralat dengan betul, memberikan maklum balas yang bermakna kepada pembangun atau pengguna.
Contoh:

// Bad
try {
  processOrder(order);
} catch (e) {
  console.log(e);
}

// Good
try {
  processOrder(order);
} catch (error) {
  console.error(`Failed to process order: ${error.message}`);
}

8. Prinsip KERING (Jangan Ulang Sendiri):
Petua: Elakkan penduaan kod dengan memfaktorkan semula logik biasa ke dalam fungsi atau modul.
Contoh:

// Bad
const userAge = getUserAge();
const userName = getUserName();

// Good
function getUserDetails() {
  return {
    age: getUserAge(),
    name: getUserName(),
  };
}

Atas ialah kandungan terperinci Amalan Terbaik untuk Menulis Kod JavaScript yang Bersih dan Boleh Diselenggara. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!