Cómo y por qué comentar en su código PHP
Share
Un comentario en el código PHP es una línea que no se lee como parte del programa. Su único propósito es ser leído por alguien que esté editando el código. Entonces, ¿por qué usar comentarios??
- Para que los demás sepan lo que estás haciendo. Si está trabajando con un grupo de personas o planea que alguien más use su script, los comentarios le dicen a los otros programadores lo que estaba haciendo en cada paso. Esto hace que sea mucho más fácil para ellos trabajar y editar su código si es necesario.
- Para recordar lo que hiciste. Aunque es posible que solo esté escribiendo un guión rápido para usted y no vea la necesidad de comentarios, continúe y agréguelos de todos modos. La mayoría de los programadores han experimentado volver para editar su propio trabajo un año o dos más tarde y tener que descubrir qué hicieron. Los comentarios pueden recordarle sus pensamientos cuando escribió el código.
Hay varias formas de agregar un comentario en el código PHP. El primero es usando // para comentar una línea. Este estilo de comentario de una línea solo comenta al final de la línea o al bloque de código actual, lo que ocurra primero. Aquí hay un ejemplo:
echo "hola";
// este es un comentario
echo "allí";
?>
Si tiene un comentario de una sola línea, otra opción es usar un signo #. Aquí hay un ejemplo de este método:
echo "hola";
#esto es un comentario
echo "allí";
?>
Si tiene un comentario de varias líneas más largo, la mejor manera de comentar es con / * y * / antes y después de un comentario extenso. Puede contener varias líneas de comentarios dentro de un bloque. Aquí hay un ejemplo:
echo "hola";
/ *
Usando este método
puedes crear un bloque de texto más grande
y todo será comentado
* /
echo "allí";
?>
No mezcle comentarios
Aunque puede anidar comentarios dentro de los comentarios en PHP, hágalo con cuidado. No todos anidan igualmente bien. PHP admite comentarios de estilo de shell C, C ++ y Unix. Los comentarios de estilo C terminan en el primer * / encuentro, así que no anides comentarios de estilo C.
Si está trabajando con PHP y HTML, tenga en cuenta que los comentarios HTML no significan nada para el analizador PHP. No funcionarán según lo previsto y es probable que ejecuten alguna función. Por lo tanto, manténgase alejado de:
