Hur och varför du ska kommentera i din PHP-kod
Share
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??
- 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 använder 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 redigera din kod om det behövs.
- För att påminna dig själv vad du gjorde. Även om du bara skriver ett snabbt manus för dig själv och inte ser behovet av kommentarer, fortsätt och lägg till dem ändå. De flesta programmerare har upplevt att komma tillbaka för att redigera sitt eget arbete ett år eller två senare och att behöva ta reda på vad de gjorde. Kommentarer kan påminna dig om dina tankar när du skrev koden.
Det finns flera sätt att lägga till en kommentar i PHP-kod. Den första är att använda // att kommentera en rad. Denna kommentarstil på en rad kommenterar endast slutet på raden eller det aktuella kodblocket, beroende på vad som kommer först. Här är ett exempel:
echo "hej";
// detta är en kommentar
echo "där";
?>
Om du har en kommentar på en rad är ett annat alternativ att använda ett #-tecken. Här är ett exempel på denna metod:
echo "hej";
# detta är en kommentar
echo "där";
?>
Om du har en längre kommentar med flera linjer är det bästa sättet att kommentera med / * och * / före och efter en lång kommentar. Du kan innehålla flera kommentarer i ett block. Här är ett exempel:
echo "hej";
/ *
Använd denna metod
du kan skapa ett större textblock
och allt kommer att kommenteras
* /
echo "där";
?>
Blanda inte kommentarer
Även om du kan häcka kommentarer i kommentarer i PHP, gör det noggrant. Inte alla bo nästan lika bra. PHP stöder C, C ++ och Unix skal-stil kommentarer. Kommentarer av C-stil slutar vid första * / de möter, så bo inte C-stilkommentarer.
Om du arbetar med PHP och HTML ska du vara medveten om att HTML-kommentarer inte betyder något för PHP-parsaren. De fungerar inte som avsett och kommer sannolikt att utföra någon funktion. Så håll dig borta från:
