Rumah > hujung hadapan web > tutorial js > Bagaimana untuk menulis kod bersih

Bagaimana untuk menulis kod bersih

Mary-Kate Olsen
Lepaskan: 2024-10-23 16:39:02
asal
433 orang telah melayarinya

Mengapa Tulis Kod Bersih? ⛩️

How to write clean code
Bayangkan jika anda cuba mencari sesuatu di dalam bilik yang tidak kemas—anda akan membuang masa mencari, bukan?

Begitu juga dengan kod kotor! LEBIH SUKAR untuk mencari masalah atau memahami apa yang berlaku. Dengan kod yang bersih, anda boleh mengelakkan kekacauan itu.

Anda tahu apa?.. Dengan menulis kod bersih anda akan menjimatkan masa pembangun lain berharga juga. Percayalah... Anda menyelamatkan dunia! ?


7 Petua untuk Menulis Kod Bersih?

How to write clean code

1. Gunakan Nama Bermakna

Apabila anda mencipta pembolehubah atau fungsi, berikannya nama yang memberitahu apa yang dilakukannya.

Fikirkan ia seperti menamakan folder pada komputer anda. Daripada memanggilnya b, memanggilnya numberOfUsers. Dengan cara ini, anda tidak memerlukan ulasan tambahan untuk menerangkan apa itu b.

Contoh:

let numberOfUsers = 5; // Clear and easy to understand
Salin selepas log masuk

2. Ikuti Prinsip Tanggungjawab Tunggal (SRP)

Sesuatu fungsi harus melakukan satu kerja dan melakukannya dengan baik.

Ini menjadikannya lebih mudah untuk difahami dan diperbaiki jika perlu. Ia seperti mempunyai satu alat untuk satu tugas, seperti pensel untuk menulis dan gunting untuk memotong.

How to write clean code

Contoh:

function addNumbers(a, b) {
    return a + b;
}
Salin selepas log masuk

Fungsi ini hanya menambah dua nombor. Ia tidak melakukan apa-apa lagi.

3. Elakkan Komen Yang Tidak Perlu

Daripada menambah komen di mana-mana, cuba jadikan kod anda jelas dengan menggunakan nama baik.

Gunakan ulasan hanya apabila sesuatu yang menyakitkan atau memerlukan nota khas. Terlalu banyak komen boleh mengelirukan orang. ??

Contoh:

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user
Salin selepas log masuk

4. Jadikan Kod Anda Boleh Dibaca

Gunakan ruang, lekukan dan pemutus baris untuk memastikan kod anda kemas.

Sama seperti menulis perenggan, anda harus memecahkan kod anda kepada kepingan yang lebih kecil supaya tidak semuanya dalam satu baris.

Contoh:

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}
Salin selepas log masuk

5. Tulis Ujian Unit

Ujian unit ialah pemeriksaan untuk kod anda.

Mereka memastikan semuanya berfungsi sebagaimana mestinya. Apabila anda menukar kod anda, ujian ini akan memberitahu anda jika ada yang rosak.

Contoh:

function add(a, b) {
    return a + b;
}

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');
Salin selepas log masuk

6. Berhati-hati dengan Kebergantungan

Apabila anda membina perisian, cuba simpan perkara itu berasingan supaya mereka tidak terlalu bergantung antara satu sama lain.

Sebagai contoh, mesin basuh pinggan mangkuk boleh berada di mana-mana dapur, bukan hanya satu dapur tertentu. Lebih mudah untuk mengurus dengan cara itu.

How to write clean code

7. Susun Projek Anda

Pastikan fail dan folder anda teratur, sama seperti memastikan meja anda bersih. Ini memudahkan anda mencari sesuatu apabila projek anda semakin besar.

How to write clean code

Contoh:

  • Gunakan folder seperti komponen, perkhidmatan dan kegunaan dalam projek anda.
  • Simpan fail yang serupa supaya anda tahu di mana hendak mencarinya.

✅ Cadangan

Gunakan Templat Pengertian Pembangun Bahagian Belakang Boleh Cetak ini untuk Menjejaki Kemajuan Anda! ?

Pembangun pemula sering bergelut dengan memilih susunan teknologi yang betul yang membawa mereka kepada masa yang terbuang dan kehilangan motivasi.

Oleh itu, saya mencipta reka bentuk yang cantik, sangat mudah untuk mengikuti pelan hala tuju pembangun bahagian belakang 6 bulan dalam Notion supaya anda boleh menjejaki kemajuan anda dan berpegang pada matlamat anda dengan mudah!

How to write clean code

Pelan hala tuju ini:

  • ?️ Menyediakan laluan yang jelas untuk mengelakkan kekeliruan.
  • ? Membantu anda kekal bermotivasi dengan menggariskan tempat untuk bermula dan berakhir.
  • ? Mengikut rancangan berstruktur, serupa dengan sukatan pelajaran sekolah.
  • ? Mengatur pembelajaran anda dengan matlamat mingguan untuk alatan dan bahasa.
  • ⏳ Memastikan siap dalam 6 bulan, meliputi semua yang anda perlukan.
  • ? Mempunyai reka bentuk yang cantik untuk navigasi yang mudah.

How to write clean code


Kesimpulan ?

Menulis kod bersih adalah seperti membina asas yang kukuh untuk sebuah rumah. Ia memastikan segala-galanya teratur, menjadikannya mudah untuk menambah perkara baharu atau membetulkan isu tanpa banyak masalah.

Ikuti 7 petua ini untuk menjadikan kod anda mudah, boleh dibaca dan mudah digunakan!

Baca lebih lanjut: kemahiran untuk menjadi pembangun bahagian belakang dalam masa 6 bulan (peta jalan)

Atas ialah kandungan terperinci Bagaimana untuk menulis kod bersih. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

sumber:dev.to
Kenyataan Laman Web ini
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn
Artikel terbaru oleh pengarang
Tutorial Popular
Lagi>
Muat turun terkini
Lagi>
kesan web
Kod sumber laman web
Bahan laman web
Templat hujung hadapan