Cómo hacer comentarios en PHP y por qué te serán útiles

Al aprender a crear sitios web con PHP, seguramente pasarás mucho tiempo construyendo páginas dinámicas; cambiando la información de tu base de datos; redireccionando las URL, y explorando algunas otras de las funcionalidades del lenguaje. 

Aunque, tal vez, destines menos tiempo a conocer una de las funciones más útiles de PHP: los comentarios. Estos elementos no corren en código, pero sí facilitan el trabajo en tus archivos.

Gracias a ellos puedes organizar mejor tu código, explicar algunas partes de él, incluso, dejar notas para ti o para tus colegas. También, son realmente valiosos para identificar y resolver bugs en tu código, por lo que emplearlos es un buen hábito al aprender a programar.

En esta guía, te mostraré los usos que puedes dar a los comentarios en PHP, así como a la forma en que puedes escribirlos en tu código.

Para qué sirven los comentarios en PHP

También, estos comentarios nos ayudan a explicar el propósito de una sección particular del código a otros programadores. De este modo, cuando un desarrollador consulta un archivo PHP por primera vez, puede comprender más rápido qué es lo que está viendo.

Asimismo, los comentarios sirven como recordatorios para que los programadores tengan presente por qué se escribió un fragmento de cierta manera. Por ejemplo, puede que hayas creado un archivo y que no regreses a él en meses. Al abrirlo de nuevo, será bueno contar con comentarios que te familiaricen otra vez con tu trabajo. O bien usarlos para dejar notas breves en el texto como: dónde te quedaste o qué hace falta revisar.

Adicionalmente, los comentarios PHP se emplean para desactivar temporalmente secciones de código, lo que es muy útil a la hora de identificar y solucionar bugs. Supongamos que has encontrado un error que se originó en tu archivo PHP. En estos casos, puedes extraer partes del código como comentarios para no perderlos, pero permitiendo que el programa corra sin ellos con el fin de probar dónde está el error. Esto es más fácil y seguro que borrar las líneas completas de código y reescribirlas.

Qué símbolo de comentario es el que se utiliza en PHP

En PHP existen dos formas de incluir un comentario. Cada una de ellas tiene diferentes funcionalidades:

• // y # permiten incluir indistintamente comentarios de una sola línea.
• /* permite incluir comentarios de más de una sola línea.

Cómo se hace un comentario en PHP

PHP ofrece dos formas de incluir comentarios: de una sola línea y de más de una. Dependiendo de tus necesidades, deberás usar alguno de los símbolos que te presenté más arriba. Veamos cómo.

Comentarios de una sola línea en PHP

Los comentarios de una sola línea son útiles para crear notas cortas antes de un bloque de código, o bien para explicar líneas del mismo. Si solo quieres incluir pocas palabras, ubicar dos diagonales (//) seguidas de tu comentario. Todo lo que aparezca del lado derecho de las diagonales será ignorado al correr el programa. También puedes usar el símbolo (#) para cumplir con el mismo objetivo.

La inclusión de comentarios de una sola línea lucirá como en el siguiente ejemplo:

<?php
echo "Este mensaje será mostrado al usuario."; // Este es muy primer output
echo “Esto será mostrado.”; # Este es mi segundo output
// echo “Esto no será mostrado al usuario.”;
# echo “Esto tampoco.”;
?>

Comentarios de más de una línea en PHP

PHP también permite crear comentarios que aparezcan distribuidos en más de una línea. Esto es especialmente útil si quieres comentar secciones grandes del código o dejar anotaciones mucho más descriptivas. Comienza escribiendo /* antes de tu comentario y no olvides cerrarlo con los símbolos */. 

Tus comentarios de más de una línea deberán lucir de la siguiente manera:

<?php
/* Este es un comentario multilínea
en PHP. Nada de esto
será mostrado al usuario. */
echo "Este mensaje será mostrado al usuario.";
?>

Por qué usar comentarios en PHP

En resumen, el uso de comentarios de una sola línea sirven para crear notas cortas que clarifiquen el propósito de una función o de una línea del código. Por su parte, los comentarios de más de una línea permiten ingresar notas más largas, detalladas y descriptivas. En cualquier caso, estos recursos te ayudarán a dar indicaciones a otros programadores o incluso para ti mismo.

En PHP (así como en otros lenguajes de programación) los comentarios suelen ser descuidados. Al principio pueden parecerte poco útiles y que solo añaden volumen innecesario a tu código, pero piensa que una vez que comiences a trabajar en equipo o en proyectos más grandes, será bueno tener anotaciones que te permitan comprender la lógica de un texto. Esto te ayudará a ahorrar tiempo y esfuerzo de lectura del código PHP.