Come e perché commentare nel tuo codice PHP
Share
Un commento nel codice PHP è una riga che non viene letta come parte del programma. Il suo unico scopo è essere letto da qualcuno che sta modificando il codice. Quindi perché usare i commenti?
- Per far sapere agli altri cosa stai facendo. Se stai lavorando con un gruppo di persone o pensi a qualcun altro che abbia mai usato il tuo script, i commenti dicono agli altri programmatori cosa stavi facendo in ogni passaggio. Questo rende molto più facile per loro lavorare e modificare il codice se necessario.
- Per ricordarti cosa hai fatto. Anche se potresti semplicemente scrivere una sceneggiatura per te stesso e non vedere la necessità di commenti, vai avanti e aggiungili comunque. La maggior parte dei programmatori ha sperimentato di tornare a modificare il proprio lavoro uno o due anni dopo e di dover capire cosa hanno fatto. I commenti possono ricordare i tuoi pensieri quando hai scritto il codice.
Esistono diversi modi per aggiungere un commento nel codice PHP. Il primo è usando // per commentare una riga. Questo stile di commento di una riga commenta solo la fine della riga o il blocco di codice corrente, a seconda di quale si verifichi per primo. Ecco un esempio:
echo "ciao";
// questo è un commento
echo "lì";
?>
Se hai un commento a riga singola, un'altra opzione è quella di utilizzare un segno #. Ecco un esempio di questo metodo:
echo "ciao";
#questo è un commento
echo "lì";
?>
Se hai un commento a più righe più lungo, il modo migliore per commentare è con / * e * / prima e dopo un lungo commento. Puoi contenere diverse righe di commento all'interno di un blocco. Ecco un esempio:
echo "ciao";
/ *
Utilizzando questo metodo
puoi creare un blocco di testo più grande
e sarà tutto commentato
* /
echo "lì";
?>
Non mescolare commenti
Anche se puoi annidare i commenti all'interno dei commenti in PHP, fallo attentamente. Non tutti nidificano ugualmente bene. PHP supporta i commenti in stile shell C, C ++ e Unix. I commenti in stile C finiscono al primo * / incontrano, quindi non annidare i commenti in stile C..
Se lavori con PHP e HTML, tieni presente che i commenti HTML non significano nulla per il parser PHP. Non funzioneranno come previsto e probabilmente eseguiranno alcune funzioni. Quindi, stai lontano da:
