Lineas de Comentarios en PHP
Los Comentarios en cualquier lenguaje de programación es el equivalente a leer un documento y pegarle postit, es decir, no se toma en cuenta como parte del documento, simplemente se ignoran cuando son ejecutados (compilados). Su uso es bastante recomendado para documentar el código que estés haciendo, indicando que hace cada linea y que hace cada función.
A futuro un código bien documentado nos permitirá comprender, modificar, editar, ampliar un código que nosotros mismos u otros programadores han hecho.
El lenguaje PHP soporta comentarios de C, C++ y Linux Shell, por tanto para comentar lineas se pueden usar lo siguiente:
|
1 2 3 4 5 6 |
<?php #Linea Comentario de Linux, Apache, etc echo "Hola "; //Otra Linea con comentario tipo C o C++ echo "Mudo"; ?> |
Y los comentarios multilinea que es para marcar de un bloque se hacen con /* */
|
1 2 3 4 5 6 7 8 9 |
<?php echo "Hola "; /*Lineas de comandos Esto no se ejecuta echo "esto tampoco";*/ echo "Mudo"; ?> |
Una Observación importante es que los comentarios multilinea comienzan con /* y terminan con el primer cierre */ que encuentren, por tanto no puedes poner un comentario multilinea dentro de otro.
|
1 2 3 4 5 6 7 8 9 |
<?php echo "Hola "; /*Lineas de comandos /*Esto es un comentario dentro de otro*/ Y estó dará error porque ya se cerró el comentario multilinea echo "esto dará tambien error, adicionalmente hay otro cierre de esta linea que es otro error";*/ echo "Mudo"; ?> |
Si ven este tema donde pongo una función, podrán observar el uso de los comentarios para documentar una función: http://www.elcodigofuente.com/limitar-numero-palabras-php-truncar-texto-largo-769/
Sin comentarios