Líneas de Comentarios en PHP

Los comentarios en cualquier lenguaje de programación es el equivalente a leer un documento y pegarle post-it, 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 línea y que hace cada función.

note_post_it

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:

<?php
#Linea Comentario de Linux, Apache, etc
echo "Hola ";
//Otra línea con comentario tipo C o C++
echo "Mudo";
?>

Y los comentarios multilínea que es para marcar de un bloque se hacen con /* */

<?php
echo "Hola ";
/*Líneas de comandos
Esto
no
se ejecuta
echo "esto tampoco";*/
echo "Mudo";
?>

Una Observación importante es que los comentarios multilínea comienzan con /* y terminan con el primer cierre */ que encuentren, por tanto no puedes poner un comentario multilínea dentro de otro.

<?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/


Posted

in

by

Comments

Agregue un comentario

Su dirección de correo no se hará público. Los campos requeridos están marcados *