Formas de comentar el código en PHP
Cuando escribí los consejos para programadores hable de lo útil que es realizar comentarios en los códigos, algo especialmente practico cuando tenemos que retomar un código luego de haberlo escrito un par de meses atrás.
Hoy un lector que recién se inicia en la programación me pregunta como se comenta el código en php, dejo las tres opciones posibles:
Comentarios de una línea
Con la doble barra: //
Ejemplo:
<?php
echo “Hello”;
//Esto es un comentario
echo ” world”;
?>
Con el carácter: #
<?php
echo “Hello”;
#Esto es un comentario
echo ” world”;
?>
Comentarios multilíneas
Con colocar al comienzo /* y al finalizar el comentario */
Ejemplo:
<?php
echo “Hello”;
/*
Este forma de comentar resulta muy practica
para cuando por ejemplo queremos escribir la licencia del codigo
o explicar en detalle algo en particular
*/
echo “World”;
?>
Muchas personas piensan que el código sin comentarios tendría que ser completamente comprensible, y esto se logra utilizando una clara nomenclatura, y buenas tabulaciones, además de un orden lógico de programación, no obstante a mi en especial me resultan útiles los comentario.
Marzo 11th, 2008 a las 15:47
hey no sabía que se puede comentar con el # en php…
el código se puede interpretar con buena sintaxis, pero los comentarios son muy buenos ayudamemorias aun en el código propio.
Marzo 11th, 2008 a las 19:21
@Joacovidal: Si no se suele utilizar mucho el numeral, al menos en mi caso no me gusta demasiado prefierra las barras de toda la vida