In PHP, come in altri linguaggi è possibile inserire commenti al codice. Chi ha esperienza, anche minima, di programmazione, sa bene che molte volte i commenti si rivelano di importanza decisiva quando si tratta modificare programmi sviluppati da altri, oppure da noi stessi, soprattutto se è passato qualche tempo dalla realizzazione. I commenti svolgono un ruolo fondamentale in questa fase di manutenzione del codice, in quanto possono facilitare di molto la comprensione di passaggi apparentemente oscuri.
È bene quindi non risparmiare mai un commento quando possibile (senza comunque esagerare altrimenti, al posto di chiarire il codice lo renderete ancora più illeggibile), anche perchè il loro utilizzo non appesantisce l'esecuzione dello script (l'interprete PHP salta tutte le parti che riconosce come commenti), nè il trasferimento della pagina al browser (infatti i commenti, essendo contenuti all'interno del codice PHP, fanno parte di ciò che non viene inviato al browser).
Abbiamo tre diverse possibilità per posizionare i commenti all'interno del nostro codice: la prima è l'uso dei commenti in stile C++, caratterizzati da due barre:
<?php
// Commento in stile C++
?>La seconda sono i commenti in stile Perl e Python, contraddistinti dall'uso del cancelletto (anche se ormai obsoleti e poco utilizzati):
<?php
# Commento in stile Perl
# e python
?>Entrambi questi tipi di commenti sono limitati ad una sola riga: l'interprete PHP, quando trova le barre o il cancelletto, salta tutto ciò che si trova da quel punto fino al termine della riga. Questo ci permette di porre il commento anche sulla stessa riga del codice commentato, così:
<?php
echo 'Buongiorno a tutti <br />';
//stampo un messaggio di saluto
print 'Esclusi quelli antipatici';
# faccio una precisazione
// Questa riga contiene solo commento
?>L'ultimo tipo di commento che abbiamo a disposizione permette di specificare commenti multilinea senza dover ripetere i caratteri ogni nuova riga grazie ad una coppia di caratteri utilizzati per l'apertura e la chiusura. Tutto il codice che segue /* viene considerato commento da PHP finchè non incontra la serie di caratteri */. Un semplice esempio:
<?php
/*
Questo è un commento
multiriga specificando
utilizzando la stessa sintassi
usata in Java e C
*/
echo /* commento */ "Ciao a tutti" /* i commenti vengono saltati*/;
?>Riguardo ai commenti multilinea, è importante ricordare che non possono essere innestati e che comunque rappresentano un separatore per l'interprete PHP. Per questo motivo le seguenti sintassi sono errate:
<?php
/*
Commento /*
multilinea
*/
Qui verrà generato un errore ...
*/
ec/* questa sintassi è errata */ho "prova";
?>La scelta di quale tipo di commento utilizzare è solitamente soggettiva, anche se spesso vengono utilizzati i commenti multiriga per documentare il codice e quelli a riga singola per aggiungergli dei semplici appunti sul funzionamento logico.