Hur och varför kommentera din PHP-kod

En kommentar i PHP-kod är en rad som inte läses som en del av programmet. Dess enda syfte är att läsas av någon som redigerar koden. Så varför använda kommentarer?

  • För att låta andra veta vad du gör. Om du arbetar med en grupp människor eller planerar att någon annan någonsin ska använda ditt skript, berättar kommentarerna för de andra programmerarna vad du gjorde i varje steg. Detta gör det mycket lättare för dem att arbeta med och att redigera din kod om det behövs.
  • För att påminna dig själv om vad du gjorde. Även om du kanske bara skriver ett snabbt manus för dig själv och inte ser behovet av kommentarer, fortsätt och lägg till dem i alla fall. De flesta programmerare har upplevt att komma tillbaka för att redigera sitt eget arbete ett eller två år senare och behöva räkna ut vad de gjorde. Kommentarer kan dock påminna dig om ditt ts när du skrev koden.

Det finns flera sätt att lägga till en kommentar i PHP-kod. Den första är genom att använda // för att kommentera en rad. Denna enradskommentarstil kommenterar bara till slutet av raden eller det aktuella kodblocket, beroende på vilket som kommer först. Här är ett exempel:

 
 


 echo "hello"; 


 //this is a comment 


 echo " there"; 


 ?>  
 Om du har en enda rad kommentar, ett annat alternativ är att använda ett #-tecken.  Här är ett exempel på denna metod: 

 
  

echo "hello";

#this is a comment

echo " there";

?>

Om du har en längre kommentar med flera rader, bästa sättet att kommentera är med /och */ före och efter en lång kommentar. Du kan innehålla flera rader med kommentarer i ett block. Här är ett exempel:

 
 


 echo "hello"; 


 /


 Using this method 


 you can create a larger block of text 


 and it will all be commented out 


 */ 


 echo " there"; 


 ?>  

Blanda inte kommentarer

Även om du kan kapsla kommentarer i kommentarer i PHP, gör det försiktigt. Alla häckar inte lika bra. PHP stöder C, C++ och Unix skalliknande kommentarer. C-stilkommentarer slutar vid den första */ de stöter på, så kapsla inte C-stilkommentarer.

Om du arbetar med PHP och HTML, var medveten om att HTML-kommentarer betyder ingenting till PHP-tolken. De kommer inte att fungera som avsett och kommer sannolikt att utföra någon funktion. Så håll dig borta från:

 

Lämna ett svar

Relaterade Inlägg

  • Så påverkar gaming samhället

  • Är det värt det att skaffa en gratis VPN-tjänst?

  • Det kan vi lära oss av tillväxten av gaming

  • Så hittar du den bästa VPN-tjänsten

  • Alltid uppkopplad – hur teknologin förändrar oss

  • Vad är Influencer marketing? En Introduktion