PHP/Programmazione/Commenti

Wikibooks, manuali e libri di testo liberi.

All'interno dei tag <?php e ?> è possibile inserire dei commenti al codice, ovvero porzioni di testo opportunamente marcate che verranno ignorate dal motore PHP durante il parsing degli script.

Un commento ha una doppia valenza:

1. può servire per non eseguire una parte di codice che però potrebbe essere necessario riprendere successivamente (ad esempio per dei test);
2. rende più leggibile il sorgente da parte di altri utenti che eventualmente debbano variare lo script PHP (nei casi soprattutto di collaborazione.

PHP supporta i commenti sia stile C che stile shell (Perl).
Il commento a linea singola quindi viene pertanto interpretato sia con // che con # anteposti alla parte di scripting da commentare.

echo "questa riga viene eseguta";
// echo "pippo";
# echo "pluto";
echo "anche questa"; //questo codice è ignorato echo ("anche questo")

In questo caso non verranno eseguite la seconda e la terza riga e la seconda parte della quarta (dal commento in poi).

È importante sottolineare che se i caratteri di commento non sono posti a inizio riga commentano solo tutto quello che si trova sulla stessa riga a destra del commento; pertanto occorre stare attenti alla sintassi per non incappare in errori. Ad esempio è corretto:

<?php 
    echo "pippo"; // Scrivo pippo 
?>

Ma attenti a scrivere:

<?php echo "pippo"; // Scrivo pippo ?>

In apparenza questi due esempi potrebbero sembrare uguali ma nel secondo caso la chiusura del tag PHP è posta sulla stessa riga a destra del commento, pertanto il linguaggio non interpreterà la chiusura del tag <?php e segnalerà un errore di sintassi.

È possibile commentare anche più di una riga di codice per volta utilizzando /* testo */. Tutto quello che si trova tra /* e */ risulta essere un commento.

echo "questo viene eseguito"; /*  
Linea 1 di commento
Linea 2   di commento
*/
echo /* "questo no" */ "anche questo" ;

Occorre fare attenzione nel non annidare i commenti di stile C, situazione che si presenta quando si commentano larghi blocchi di codice.

/*
     echo 'Questo è il primo commento'; /* Questo commento dà errore */
     */

Tutta la parte in grassetto rappresenta un unico commento per cui */ nella riga successiva genererà un errore