Un comentario en cualquier programa informático (como un programa PHP) es un determinado texto explicativo que es ignorado por el compilador/intérprete del lenguaje. Su propósito es ayudar al usuario a comprender la lógica utilizada en el algoritmo del programa.

Aunque colocar comentarios en el código no es imprescindible, es una práctica muy recomendable. Los comentarios también sirven como documentación del programa. Los comentarios también son útiles cuando es necesario depurar y modificar el código.

Hay dos formatos de comentarios en PHP:

• Comentarios de una sola línea
• Comentarios de varias líneas

Comentarios de una sola línea

Por lo general, se utilizan para explicaciones breves o notas relevantes para el código local. PHP utiliza dos notaciones para insertar un comentario de una sola línea en un programa.

Comentarios de una sola línea usando «#»

Una línea en el código PHP que comienza con el símbolo «#» se trata como un comentario de una sola línea.

<?php
   # Single line comment starting with # symbol
   echo 'Hello World';
?>

Comentarios de una sola línea usando «//»

PHP también soporta el estilo C de comentarios de una sola línea con el símbolo «//». Una línea que comienza con un símbolo de doble oblicuo se trata como un comentario.

<?php
   // Single line comment starting with // symbol
   echo 'Hello World';
?>

No es necesario cerrar un comentario que comience con el símbolo «#» o «//». El efecto de estos símbolos dura hasta el final de la línea física.

En otras palabras, el analizador PHP tratará la siguiente línea como una declaración PHP y no como un comentario, incluso si no hay un marcador de comentario de cierre.

Comentarios de varias líneas

Los comentarios de varias líneas se utilizan generalmente para proporcionar algoritmos de pseudocódigo y explicaciones más detalladas cuando es necesario.

El estilo de comentario de varias líneas es el mismo que en C. Una o más líneas incrustadas dentro de los símbolos «/*» y «*/» se tratan como un comentario.

Ejemplo de comentario multilínea en PHP

Este es el ejemplo de un comentario de varias líneas.

<?php

   /* This is a multiline comment example
   program to add two numbers
   Variables used - $x for first number, 
   $y for second number */
   
   $x=10;
   $y=20;
   print "Total = ". $x+$y;
?>

Tenga en cuenta que puede poner incluso una sola línea dentro de «/* .. */». Sin embargo, si hay un símbolo «/*» en el programa, debe tener un marcador de cierre al final del comentario «*/». De lo contrario, se mostrará un error de la siguiente manera:

PHP Parse error:  Unterminated comment starting line 3 in /home/cg/root/65ded9eeb52fc/main.php on line 3