Menjadi Pengekod yang Lebih Baik: Petua

Dengan banyak amalan terbaik Python yang beredar dalam talian, pendapat tentang setiap satu boleh berbeza-beza bergantung pada orang yang anda tanya. Internet telah mendemokrasikan kepakaran, membenarkan sesiapa sahaja — termasuk saya sendiri — berkongsi pandangan mereka. Walau bagaimanapun, dalam artikel ini, kami akan menumpukan pada 10 amalan terbaik Python abadi yang telah mencapai konsensus yang meluas dan dianggap secara meluas sebagai asas.

Lembaran Cheat Panda

lembaran curang Perintah Git

50 Soalan Temuduga SQL Teratas

Petua 1: Fungsi Harus Menentukan Parameter Dan Jenis Pemulangan
Apabila mentakrifkan fungsi, anda ingin sentiasa menentukan jenis hujah dan jenis data yang dipulangkan oleh hasil fungsi tersebut. Ini akan membantu anda dan pembangun dalam pasukan anda mengetahui perkara yang diharapkan tanpa perlu sentiasa menggunakan kenyataan cetakan untuk mendapatkan pemahaman visual.

Petua 2: Fungsi Harus Pada Tahap Abstraksi Yang Sama
Apabila kita bercakap tentang fungsi berada pada tahap abstraksi yang sama, kita merujuk kepada idea bahawa fungsi harus melaksanakan satu tugasan yang jelas. Tugas itu harus berada pada tahap abstraksi yang konsisten sepanjang fungsi. Dalam erti kata lain, fungsi harus menumpukan pada tahap perincian atau kerumitan tertentu dan semua operasi fungsi harus beroperasi pada tahap yang sama.

Petua 3: Fungsi Harus Kecil
Fungsi dimaksudkan untuk diguna semula. Dan semakin besar fungsi itu, semakin kecil kemungkinan ia boleh diguna semula. Ini juga berkait dengan mengapa fungsi perlu melakukan satu perkara sahaja. Jika ia hanya melakukan satu perkara, ada kemungkinan besar ia akan menjadi kecil.

Petua 4: Buka Prinsip Tertutup
Prinsip tertutup terbuka (OCP) menyatakan bahawa kelas, kaedah atau fungsi mesti terbuka untuk sambungan tetapi bukan pengubahsuaian. Ini bermakna mana-mana kelas, kaedah atau fungsi yang ditakrifkan boleh digunakan semula atau dilanjutkan dengan mudah untuk berbilang keadaan tanpa mengubah kodnya.
Ini gagal mematuhi OCP kerana apabila terdapat negara baharu, kami perlu menulis kenyataan if baharu untuk melengkapkannya. Ini mungkin kelihatan mudah sekarang tetapi bayangkan kita mempunyai 100 atau lebih negara untuk diambil kira. Bagaimanakah rupanya?

Petua 5: Elakkan Komen Pada Semua Kos
Komen mempunyai cara untuk menjadi benar palsu. Mereka menyimpang fikiran pembaca daripada apa yang sebenarnya dilakukan oleh kod kepada apa yang orang lain katakan ia lakukan.

Ini boleh menjadi sangat bermasalah apabila masa berlalu dan kod menerima kemas kini atau perubahan. Pada satu ketika, komen itu menjadi pembohongan dan semua orang kini perlu melihat kebenaran melalui lensa pembohongan.

Komen mesti dielakkan pada semua kos. Komen memaksa pembaca untuk mewarisi pemikiran anda yang paling baik adalah pada masa lalu. Apabila fungsi atau kelas berubah, kemungkinan besar, ulasannya tidak berubah bersama-sama dengannya. Kemungkinan besar, mereka menghalang pembaca daripada berfikir ke hadapan.

Ulasan menandakan bahawa penulis tidak berupaya secara mental memberikan kelas, fungsi atau nama pembolehubah yang deskriptif dengan baik. Ia mendedahkan sikap tidak bersemangat pengaturcara dan memaksa pasukan untuk mewarisi sikap sedemikian.

Petua 6: Elakkan Nombor Ajaib
Nombor Ajaib ialah nilai berkod keras yang mungkin berubah pada peringkat kemudian, tetapi itu mungkin sukar untuk dikemas kini.

Sebagai contoh, katakan anda mempunyai Halaman yang memaparkan 50 Pesanan terakhir dalam Halaman Gambaran Keseluruhan "Pesanan Anda". 50 ialah Nombor Ajaib di sini kerana ia tidak ditetapkan melalui standard atau konvensyen, ia adalah nombor yang anda buat atas sebab yang digariskan dalam spesifikasi.

Sekarang, apa yang anda lakukan ialah anda mempunyai 50 di tempat yang berbeza — skrip SQL anda (PILIH 50 TERATAS * DARI pesanan), Laman Web anda (50 Pesanan Terakhir Anda), log masuk pesanan anda (untuk (i = 0; i < ; 50; i )) dan mungkin banyak tempat lain.

Petua 7: Elakkan Bersarang Dalam
Hadkan tahap sarang dalam gelung, bersyarat atau fungsi untuk meningkatkan kebolehbacaan.

Petua 8: Elakkan Laluan Pengekodan Keras
Elakkan laluan fail atau URL pengekodan keras; gunakan fail konfigurasi atau pembolehubah persekitaran.

Petua 9: Kelas hendaklah kecil
Yap! Kelas hendaklah sekecil mungkin. Sama seperti fungsi.

Satu-satunya perbezaan ialah dalam fungsi, saiz ditentukan oleh bilangan baris dalam fungsi itu manakala dalam kelas, ia ditentukan oleh bilangan tanggungjawab dalam kelas tersebut.

Biasanya, nama kelas mewakili jenis tanggungjawab yang mungkin dimilikinya tetapi apabila nama itu samar-samar atau terlalu umum, kemungkinan besar kami memberi terlalu banyak tanggungjawab.

Ini membawa kita kembali kepada SRP (prinsip tanggungjawab tunggal) yang menyatakan bahawa kelas hanya perlu mempunyai satu sebab — satu tanggungjawab — untuk berubah.

Petua 10: Elakkan Ungkapan Ternary Kompleks
Elakkan daripada menggunakan ungkapan ternary yang terlalu kompleks; mengutamakan kebolehbacaan daripada ringkas untuk menjadikan kod lebih mudah difahami.

Atas ialah kandungan terperinci Menjadi Pengekod yang Lebih Baik: Petua. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!