Ringkasan Kod Bersih

Kod adalah bersih jika ia boleh difahami dengan mudah – oleh semua orang dalam pasukan. Kod bersih boleh dibaca dan dipertingkatkan oleh pembangun selain daripada pengarang asalnya. Dengan kebolehfahaman datang kebolehbacaan, kebolehubah, kebolehlanjutan dan kebolehselenggaraan.
Peraturan am

• Ikut konvensyen standard.
• Pastikan ia mudah bodoh. Lebih mudah sentiasa lebih baik. Kurangkan kerumitan sebanyak mungkin.
• Peraturan pengakap lelaki. Biarkan tapak perkhemahan lebih bersih daripada yang anda temui.
• Sentiasa cari punca. Sentiasa cari punca masalah.

Peraturan reka bentuk

1. Simpan data boleh dikonfigurasikan pada tahap tinggi.
2. Lebih suka polimorfisme daripada if/else atau tukar/case.
3. Asingkan kod berbilang benang.
4. Elakkan kebolehkonfigurasian yang berlebihan.
5. Gunakan suntikan pergantungan.
6. Ikut Hukum Demeter. Sesebuah kelas harus mengetahui hanya kebergantungan langsungnya.

Petua kefahaman

1. Kekal konsisten. Jika anda melakukan sesuatu dengan cara tertentu, lakukan semua perkara yang serupa dengan cara yang sama.
2. Gunakan pembolehubah penjelasan.
3. Merangkum keadaan sempadan. Keadaan sempadan sukar dijejaki. Letakkan pemprosesan untuk mereka di satu tempat.
4. Lebih suka objek nilai khusus daripada jenis primitif.
5. Elakkan pergantungan logik. Jangan tulis kaedah yang berfungsi dengan betul bergantung pada sesuatu yang lain dalam kelas yang sama.
6. Elakkan syarat negatif.

Peraturan nama

1. Pilih nama deskriptif dan tidak jelas.
2. Buat perbezaan yang bermakna.
3. Gunakan nama yang boleh disebut.
4. Gunakan nama yang boleh dicari.
5. Gantikan nombor ajaib dengan pemalar bernama.
6. Elakkan pengekodan. Jangan tambahkan awalan atau taip maklumat.

Peraturan fungsi

1. Kecil.
2. Lakukan satu perkara.
3. Gunakan nama deskriptif.
4. Pilih lebih sedikit hujah.
5. Tiada kesan sampingan.
6. Jangan gunakan hujah bendera. Pisahkan kaedah kepada beberapa kaedah bebas yang boleh dipanggil daripada klien tanpa bendera.

Peraturan ulasan

1. Sentiasa cuba menerangkan diri anda dalam kod.
2. Jangan berlebihan.
3. Jangan tambah bunyi yang jelas.
4. Jangan gunakan ulasan pendakap penutup.
5. Jangan komen keluar kod. Keluarkan sahaja.
6. Gunakan sebagai penjelasan tentang niat.
7. Gunakan sebagai penjelasan kod.
8. Gunakan sebagai amaran tentang akibatnya.

Struktur kod sumber

1. Asingkan konsep secara menegak.
2. Kod berkaitan sepatutnya kelihatan padat menegak.
3. Isytiharkan pembolehubah hampir dengan penggunaannya.
4. Fungsi bergantung harus dekat.
5. Fungsi yang serupa sepatutnya dekat.
6. Letakkan fungsi ke arah bawah.
7. Pastikan baris pendek.
8. Jangan gunakan penjajaran mendatar.
9. Gunakan ruang putih untuk mengaitkan perkara yang berkaitan dan mengaitkan yang berkaitan dengan lemah.
10. Jangan patahkan lekukan.

Objek dan struktur data

1. Sembunyikan struktur dalaman.
2. Lebih suka struktur data.
3. Elakkan struktur hibrid (separuh objek dan separuh data).
4. Hendaklah kecil.
5. Lakukan satu perkara.
6. Bilangan kecil pembolehubah tika.
7. Kelas asas sepatutnya tidak tahu apa-apa tentang terbitan mereka.
8. Lebih baik mempunyai banyak fungsi daripada menghantar beberapa kod ke dalam fungsi untuk memilih tingkah laku.
9. Lebih suka kaedah bukan statik daripada kaedah statik.

Ujian

1. Satu penegasan setiap ujian.
2. Boleh dibaca.
3. Cepat.
4. Berdikari.
5. Boleh diulang.

Kod berbau

1. Ketegaran. Perisian ini sukar untuk diubah. Perubahan kecil menyebabkan perubahan seterusnya.
2. Kerapuhan. Perisian rosak di banyak tempat kerana satu perubahan.
3. Imobilitas. Anda tidak boleh menggunakan semula bahagian kod dalam projek lain kerana melibatkan risiko dan usaha yang tinggi.
4. Kerumitan Tidak Perlu.
5. Pengulangan Tidak Perlu.
6. Kelegapan. Kod ini sukar difahami.

Itu banyak yang saya rasa, Tetapi ada lagi.
Baca buku penuh.

Terima kasih kerana membaca Ringkasan, Semoga ia membantu.

Tapak web:
https://kaleemelahi.co

Beli Saya CoFee:
https://buymeacoffee.com/kaleemelahi

Atas ialah kandungan terperinci Ringkasan Kod Bersih. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!