Peril komen multiline bersarang di php

PHP tidak menyokong komen multiline bersarang, dan cuba bersarang mereka boleh menyebabkan pelaksanaan kod yang tidak dijangka atau menghuraikan ralat; Yang pertama / menutup seluruh blok komen, jadi mana -mana kod yang mengikutinya -walaupun dimaksudkan untuk dikomentari -akan dilaksanakan, yang membawa kepada pepijat atau kesilapan maut apabila fungsi secara tidak sengaja dilarutkan; Untuk mengelakkan ini, gunakan // Komen, Blok IDE mengulas, atau membungkus kod dalam jika (0) {} bukan/ */ apabila mengulas kod yang mengandungi komen yang ada. P>

Anda tidak boleh mengadakan komen multiline di PHP-dan cuba melakukannya boleh membawa kepada pepijat yang halus dan sukar ditangkap. Walaupun ini mungkin kelihatan seperti quirk bahasa yang kecil, ia adalah perangkap yang nyata, terutamanya apabila mengulas blok besar kod semasa debugging atau refactoring.

PHP hanya mengiktiraf /* */ sebagai pemadam komen multiline, dan yang pertama */ menutup seluruh blok komen - tanpa mengira berapa banyak /* sebelum ini. Ini bermakna bersarang tidak berfungsi dengan cara yang anda harapkan dari bahasa lain atau pembinaan pengaturcaraan.

Apa yang berlaku apabila anda cuba bersarang?

Pertimbangkan kod yang tidak berbahaya ini:

 /*
    Beberapa fungsi penting
    /*
        Ini adalah komen bersarang
    */
    Masih di dalam apa yang saya fikir adalah komen
*/
echo "Hello, World!";

Anda mungkin mengharapkan keseluruhan blok untuk dikomentari - termasuk pernyataan echo . Tetapi inilah yang sebenarnya berlaku:

• Yang pertama /* memulakan komen.
• Yang pertama */ (selepas "komen bersarang") mengakhiri komen.
• Segala -galanya selepas itu - termasuk Still inside... dan echo - dilaksanakan sebagai kod PHP .

Jadi echo "berkomentar" anda akan berjalan, dan anda akan mendapat output. Lebih buruk lagi, jika ada sintaks PHP yang tidak sah atau tidak lengkap selepas pramatang */ , anda akan mendapat ralat parse yang mengelirukan untuk debug.

Mengapa ini berbahaya dalam amalan

Risiko terbesar bukan teori - ketika pemaju menggunakan /* ... */ untuk sementara mematikan potongan kod.

Bayangkan senario ini semasa debugging:

 /*
fungsi ProcessUserData ($ data) {
    / * Mengesahkan input */
    jika (! isvalid ($ data)) {
        LogError ("data tidak sah");
        kembali palsu;
    }
    PerformAction ($ data);
}
*/

Nampak selamat, bukan? Tetapi komen dalaman ( /* Validate input */ ) mengandungi */ , yang menamatkan komen luar awal. Hasilnya?

• function processUserData(...) tidak lagi mengulas.
• Jika fail ini dimasukkan atau dijalankan, fungsi akan ditakrifkan - mungkin menyebabkan konflik atau tingkah laku yang tidak diingini.
• Lebih buruk lagi: Jika fungsi sudah wujud, anda akan mendapat ralat "tidak boleh redeclare" yang membawa maut.

Kesalahan semacam ini sangat berbahaya kerana:

• Tidak ada amaran dari PHP.
• Penyerap sintaks kadang -kadang gagal menangkapnya, mewarnai segala -galanya sebagai "berkomentar" apabila tidak.
• Kesalahan mungkin kelihatan jauh dari sebab sebenar.

Alternatif yang lebih selamat

Daripada bergantung pada /* */ , gunakan pendekatan yang lebih selamat ini:

• Gunakan komen berbilang baris ( // )
  Terutama untuk debuging sementara:

   // ProsesUserData fungsi ($ data) {
  // jika (! isvalid ($ data)) {
  // logError ("data tidak sah");
  // kembali palsu;
  //}
  // PerformAction ($ data);
  //}

• Gunakan Blok IDE mengulas
  Kebanyakan editor membolehkan anda memilih kod dan togol // pada setiap baris dengan pintasan. Ia pantas dan selamat.

• Gunakan # untuk komen gaya shell
  Tingkah laku yang sama sebagai // , tetapi ada yang lebih suka untuk perbezaan visual.

• Untuk blok besar, pertimbangkan membungkus if (0) { ... }
  Contoh:

   jika (0) {
      fungsi ProcessUserData ($ data) {
          / * Mengesahkan input */
          jika (! isvalid ($ data)) {
              LogError ("data tidak sah");
              kembali palsu;
          }
          PerformAction ($ data);
      }
  }

  Ini memastikan kod itu dihuraikan (jadi kesilapan sintaks masih ditangkap) tetapi tidak pernah dilaksanakan.

  Bottom line

  Komen multiline PHP tidak menyokong bersarang - berhenti penuh. Bergantung pada mereka untuk memberi komen kod dengan ada /* */ komen di dalamnya meminta masalah. Parser tidak peduli dengan lekukan atau niat; Ia berhenti pada yang pertama */ .

  Pembaikan? Elakkan /* */ untuk mengulas kod semasa pembangunan. Melekat pada // atau gunakan blok bersyarat. Ini adalah perubahan kebiasaan kecil yang menghalang sakit kepala besar.

  Pada asasnya: jika anda mengulas kod yang mengandungi apa -apa /* atau */ , anggap ia akan pecah. Merancang dengan sewajarnya.

  Atas ialah kandungan terperinci Peril komen multiline bersarang di php. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!