Ramai pembangun percaya bahawa keutamaan pertama ialah memahami keperluan dan menulis kod dengan cepat. Walau bagaimanapun, pandangan ini adalah cacat. Salah satu tanggungjawab pembangun ialah menulis dokumentasi yang sesuai, tetapi ini sering disalahertikan atau tidak dilaksanakan dengan baik. Sesetengah pembangun menulis secara bertele-tele sehinggakan keperluan teras atau logik perniagaan dikaburkan - ini seperti membunuh ayam dengan mata yang tajam.
Menulis dokumentasi baris demi baris tidak menjadikan kod lebih mudah dibaca secara automatik. Dokumentasi harus menumpukan hanya pada maklumat yang diperlukan, terutamanya apabila menerangkan keperluan projek utama atau logik perniagaan. Tetapi ini tidak bermakna bahawa dokumentasi boleh diabaikan sepenuhnya untuk kes-kes yang mudah, sebaliknya, kod yang ditulis dengan baik dan penerangan sendiri selalunya boleh mengurangkan keperluan untuk dokumentasi yang berlebihan.
Senario biasa ialah menggunakan jadual pangkalan data untuk menyemak sama ada data wujud atau mengira bilangan baris untuk pemprosesan selanjutnya. Fungsi pembantu ialah penyelesaian yang sangat baik untuk tugasan berulang tersebut. Pertimbangkan contoh berikut:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|
Pendekatan ini jelas dan ringkas tanpa kerumitan yang tidak perlu. Fungsi ini mencapai tujuannya dengan cekap dan intuitif untuk digunakan. Tetapi mari kita lihat contoh perbandingan:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
Di sini, fungsi simple_read
sedang disalahgunakan untuk tugas yang tidak direka bentuk untuknya. Jika jadual products
mempunyai 20 baris, fungsi ini hanya akan mengembalikan baris pertama jadual. Jika tiada data, ia mengembalikan NULL. Ini menimbulkan persoalan: bolehkah NULL dibandingkan dengan 0? sama sekali tidak. Jadi jika tiada data dalam jadual, kod akan membuang ralat. Menulis dokumentasi terperinci untuk kod yang cacat ini tidak menjadikannya lebih baik. Ia seperti menambah lapisan penjelasan kepada penyelesaian yang pada asasnya salah.
Dengan mengimbangi dokumentasi yang bermakna dengan kod yang tersusun dengan baik, pembangun dapat memastikan kerja mereka cekap dan mudah diselenggara. Akhirnya, ia bukan hanya tentang menulis kod;
Atas ialah kandungan terperinci Kepentingan Menulis Kod dan Dokumentasi Bermakna. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!