PHPDOC dan IDE anda

PHP mengabaikan overhead pelaksanaan komen, kerana komen dibuang semasa peringkat penyusunan dan tidak akan memasuki proses pelaksanaan opcode; 2. Satu -satunya kesan prestasi yang boleh diabaikan adalah masa parsing mikrosecond apabila skrip pertama dimuatkan, dan hampir tidak ada kesan selepas Opcache diaktifkan; 3. Keutamaan harus dibayar kepada kesesakan prestasi sebenar seperti pertanyaan pangkalan data dan gelung, dan bukannya bilangan komen.

Phpdoctagsarestructuredannotationsthatdocumentcodeforbetterundersterstandingandtoolingsupport; 1)@paramdescribesfunctionParameterswithtypeanddescription, 2)@returnspecifiestheretherethypeandmeaning, 3)

Terangkan "mengapa" daripada "apa yang perlu dilakukan", seperti melangkau garis tajuk CSV; 2. Gunakan komen kurang dalam talian dan menggantikan logik kompleks dengan nama fungsi yang jelas; 3. Menunjukkan kes kelebihan, seperti peti mel balik adalah mematuhi GDPR apabila ia kosong; 4. Gunakan PHPDOC untuk menyeragamkan parameter dan pengecualian API awam; 5. Simpan komen yang dikemas kini, komen yang sudah lapuk lebih buruk daripada tiada komen.

Terangkan logik yang tidak jelas, seperti memintas bug perpustakaan pihak ketiga atau pengoptimuman prestasi; 2. Algoritma kompleks rekod atau formula matematik seperti pengiraan kepentingan kompaun; 3. Tanda item To-Do atau perbaikan sementara, gunakan // todo: atau // fixme; 4. Gunakan PHPDOC yang berguna dan ringkas untuk menerangkan niat dan bukannya sintaks pendua dalam kaedah awam - ringkasnya, komen apabila orang lain mungkin keliru "mengapa menulis cara ini", jika tidak, simpan kod itu bersih.

Jangan tulis maklumat sensitif (seperti kata laluan, kekunci API) dalam komen, kerana ia mungkin didedahkan oleh log atau kawalan versi, dan anda harus menggunakan pembolehubah persekitaran atau alat pengurusan utama; 2. Jangan "annotate" kod ketinggalan zaman dengan komen, yang akan menyebabkan kekeliruan, dan anda harus memadamkannya secara langsung dan memulihkannya dengan sejarah git, dan menjelaskan sebab penghapusan jika perlu; 3. Jangan tulis komen tidak masuk akal yang jelas (seperti "membuat tatasusunan kosong"), biarkan nama -nama pemboleh ubah ditafsirkan sendiri, dan hanya menjelaskan "mengapa" apabila logik itu rumit; 4. Jangan biarkan todo/fixme yang besar tanpa orang yang bertanggungjawab dan tarikh akhir, yang mudah menjadi sampah. Anda harus menggunakan alat pengurusan projek untuk menjejaki mereka, atau menunjukkan orang yang bertanggungjawab dan tarikh akhir dalam komen.

Gunakan htmlspecialchars () dan pernyataan pra -proses untuk mencegah suntikan XSS dan SQL; 2. Sahkan input melalui trim (), pemeriksaan panjang dan filter_var (); 3. Tambah medan honeypot atau recaptchav3 untuk menahan komen spam; 4. Gunakan token CSRF untuk memastikan bahawa sumber bentuk boleh dipercayai; 5. Gunakan pernyataan pra -proses semasa penyimpanan dan htmlpurifier untuk membersihkan kandungan sebelum dipaparkan, dan jangan mempercayai input pengguna sepanjang proses, untuk membina sistem komen PHP yang selamat.

Keutamaan diberikan kepada penggunaan komen "mengapa" dan bukannya "apa yang perlu dilakukan", kerana bekas menyediakan latar belakang atau logik perniagaan yang tidak dapat diungkapkan oleh kod itu; 2. Elakkan pertindihan kandungan yang telah dinyatakan dengan jelas oleh Kod, dan meningkatkan kebolehbacaan dengan meningkatkan penamaan pembolehubah atau fungsi; 3. Gunakan komen blok phpDoc untuk menerangkan fungsi fungsi fungsi, dan simpan komen dalam talian yang difokuskan pada menjelaskan sebab-sebab membuat keputusan, dengan itu meningkatkan pemeliharaan kod dan menjimatkan masa pembangunan berikutnya.

Apabila kod itu tidak intuitif (seperti operasi bit dan keteraturan), anda mesti memberi komen mengenai niat; 2. Fungsi awam perlu mengulas mengenai tujuan dan logik tersirat (seperti bergantung pada status percutian); 3. Gunakan TODO/FIXME untuk menandakan rancangan sementara atau item tugasan (seperti alamat API hardcoded); 4. Apabila memetik algoritma luaran, sumber (seperti pautan stackoverflow); Inti anotasi adalah untuk mengurangkan kos pemahaman, bukan untuk membuat nombor.