PHP » Comentar código fuente PHP

PHP

Existen dos formas de comentar su código fuente PHP para informarse en el futuro de qué trata el código fuente.

Al igual que en cualquier otro lenguaje, ya sea de programación o de marcado como el XHTML, dispone de su propia forma para incluir comentarios informativos directamente en el código fuente.

Los comentarios son muy útiles a la hora de volver a leer nuestro código fuente, porque nos entrega y facilita nuestra propia información acerca del código que hemos creado.

Comentarios de una línea

El PHP nos entrega dos formas para incluir nuestros comentarios. La primera forma, es para comentar el código de forma simple y en una línea. Esta se puede incluir solo antes o después de terminar una línea de código para que no irrumpa en el código real.

Para comentar en un línea, se debe anteponer dos barras (//) al principio de la línea, la que se delimita por el salto de línea de la misma.

Ejemplo PHP:

<?php

// El siguiente código es para imprimir la frase "Hola mundo".
echo "Hola mundo";

?>

Comentarios de varias líneas

La segunda forma, es para incluir un comentario de varias líneas. Este es generalmente usado para mostrar códigos fuentes eliminados o textos largos de varias líneas.

Para comentar en varias líneas, se deben encerrar esta líneas por los carácteres "/*" al principio y "*/" al final.

Ejemplo PHP:

<?php

/* En el código:
echo "Hola mundo";
puedo cambiar la frase entre comillas por cualquier otra. */

echo "Hola mundo";

?>

En un procesador de textos, generalmente, los comentarios son presentados de color verde.

Resultados de los comentarios

No existe un resultado para el comentario, pues es solo visible en el código fuente. El comentario solo sirve para tu lectura o para alguien que tenga acceso a tu código PHP.