Poner comentarios en php, como en cualquier otro lenguaje de programación, es de vital importancia, no por el funcionamiento en sí del script o algoritmo que estemos programando, sino a la hora de hacer revisiones del mismo, al compartirlo con otros programadores del equipo en el que trabajemos o para la resolución de errores cuando el comportamiento del código no es el esperado.

En PHP hay tres maneras de colocar los comentarios. Una de ellas nos permite poner comentarios de gran longitud, mientras que los otros dos son de una sóla línea.

El primer tipo de comentario en PHP, de varias líneas se encuentra entre los símbolos slash + asterisco (/*) apertura y asterisco + slash (*/) cierre. Dicho de otro modo, todo lo que se encuentre /* y */ será ignorado por el compilador php.

Veamos un ejemplo.

/* La función sendEmail admite como parámetro un array con los siguientes elementos:

1- dirección del destinatario

2- dirección del remitente

3 - título

*/

function sendEmail($params){


Como decimos todo lo incluído entre los asteriscos será ignorado.

El segundo y el tercer tipo sirven para poner comentarios que sólo ocupen una línea, o parte de ella. Comienzan por una doble slash (//) o una almohadilla (#).

Veamos un ejemplo de ambas:

#Esta función evvía un email con los datos del array $params

if($mj->sendEmail($params)){


Pero hemos de saber que el comentario no tiene porqué abarcar toda la línea completa, puede hacerlo sólo de la parte final.

$mj->sendEmail($params); #Envía un email con los datos del array $params

}//fin del foreach que recorre el arrray $reviewData


La colocación de comentarios es muy imporante en la solución de errores ya que podemos poner como comentario parte de código del que tengamos duda o que reemplazamos por otro, para descubrir en qué línea en concreto el resultado del código se volvió impredecible.

Comparte este Goo:

¿Tiene contenido inapropiado?

Comparte este goo con un amigo: