Commenti in PHP: come e perchè inserirli nel codice

Prima di proseguire e addentrarci in aspetti più articolati della programmazione con PHP, vorrei soffermarmi sull’importanza di inserire, con costanza e continuità, commenti al codice all’interno degli script che andremo a realizzare con questo linguaggio. I commenti non solo rendono il codice più leggibile, ma ne facilitano anche la manutenzione e l’evoluzione nel tempo.

I commenti al codice sono delle “note” che il programmatore aggiunge, per comodità, al codice stesso. Si tratta di “appunti”, semplice testo che non viene né elaborato né stampato a video: in pratica, si tratta di riferimenti interni che possono essere letti solo dallo sviluppatore che lavora sul codice sorgente dello script.

Ad esempio, potrebbe essere utile scrivere sopra a una determinata funzione qual è il suo compito o come deve essere utilizzata nel contesto applicativo, oppure il perché di una determinata sequenza di passaggi necessari per raggiungere un certo risultato.

I commenti sono fondamentali (e non devono essere trascurati) per una serie di motivi:

• perché semplificano interventi al codice effettuati in un momento successivo alla sua creazione (dopo molto tempo, infatti, certi passaggi logici potrebbero apparire meno chiari);
• perché facilitano il compito di altre persone chiamate a lavorare sul nostro codice, rendendo più semplice la comprensione delle logiche implementate.

Come scrivere un commento in PHP

Scrivere un commento all’interno del codice PHP è molto semplice… basta iniziare una riga con // oppure con #. Tutto quello che ne viene posizionato a destra non verrà processato da PHP e pertanto non avrà alcun effetto durante l’elaborazione. Facciamo un esempio:

<?php
// Uso echo...
echo "ciao...";

# Ed ora uso print!
print "ciao...";
?>

In alternativa, possiamo scrivere commenti alla fine della riga di codice, come mostrato qui sotto:

<?php
echo "ciao..."; // Uso echo...
print "ciao..."; # Ed ora uso print!
?>

Quelli visti fino ad ora sono commenti su singola linea; qualora, invece, volessimo scrivere commenti su più righe, potremo usare questa sintassi:

/*
questo è un commento su più righe...
questo è un commento su più righe...
questo è un commento su più righe...
*/
echo "ciao...";

Come avrete notato, è considerato commento tutto ciò che è compreso tra /* e */, a prescindere dal numero di linee occupate. I commenti multilivello possono risultare particolarmente utili quando è necessario spiegare parti complesse del codice o quando si desidera annotare informazioni dettagliate sui vari aspetti del programma.