Al aprender PHP para crear un sitio web, pasará la mayor parte de su tiempo aprendiendo cómo usar el lenguaje para crear páginas dinámicas, modificar datos de bases de datos y otras características útiles del lenguaje.
Sin embargo, es posible que no sepa acerca de los comentarios. El código anotado no «funciona» como el resto del código, pero facilita mucho el trabajo con los archivos.
Los comentarios de PHP ayudan a organizar y aclarar partes de su código que pueden no estar claras para otros desarrolladores de back-end que lo lean por primera vez, o para que usted se aleje de su código después de un tiempo. También son útiles para depurar errores molestos y un buen hábito para desarrollar desde el principio.
En esta guía, le mostraremos cómo usar los comentarios de PHP para mejorar su código, incluidas dos formas diferentes de escribirlos.
¿Qué son los comentarios de PHP?
En PHP, los comentarios son secciones de código que no se ejecutan al iniciar el programa. Los usuarios finales no pueden ver los comentarios PHP; solo son visibles cuando ven el código PHP en el archivo. Los comentarios de PHP generalmente están destinados a ayudar a los desarrolladores a comprender e interpretar el código PHP.
Un comentario de PHP puede dejar en claro a otros desarrolladores el propósito de una sección particular de código. De esa forma, cuando un desarrollador ve por primera vez un archivo PHP, puede ser más fácil entender el código que está viendo.
Asimismo, los comentarios ayudan a recordar a los desarrolladores por qué escribieron el código de cierta manera. Puede crear un archivo PHP y luego no volver a él durante meses o años. Cuando finalmente vuelva a abrir el archivo, querrá comentarios completos para que pueda familiarizarse rápidamente con el código anterior. También puede usar los comentarios para agregar notas breves a usted mismo, como dónde lo dejó.
Además, los comentarios de PHP se pueden usar para desactivar temporalmente secciones específicas de código con fines de depuración. Suponga que encontró un error en algún lugar de un archivo PHP: puede «comentar» parte del código, reiniciar el programa y ver si el error persiste. Esto es mucho más fácil (y más seguro) que eliminar líneas de código durante la depuración.
Sintaxis de comentarios de PHP
PHP tiene dos comentarios integrados: comentarios de una sola línea y comentarios de varias líneas. Se escriben un poco diferente.
Comentarios PHP de una sola línea
Los comentarios PHP de una sola línea son útiles para hacer notas breves antes de un bloque de código o para explicar una sola línea de código. Para dejar un comentario de una sola línea, escriba dos barras (//) seguido del texto del comentario. Todo el texto a la derecha de // será ignorado. También puede utilizar el símbolo hash (#) en cambio // para agregar un comentario de una línea.
<?php
echo "This message will be printed to the user."; // This is my first output
echo “This will be also be printed.”; # This is my second output
// echo “This will not be printed to the user.”;
# echo “And neither will this.”;
?>
Comentarios PHP de varias líneas
PHP también permite comentarios que ocupan varias líneas, en caso de que desee comentar una gran parte del código o dejar un comentario más descriptivo. Comience su comentario de varias líneas escribiendo / * y termínalo escribiendo * /. Por ejemplo:
<?php
/* This is a multiline PHP
comment. None of this
will be shown to the user. */
echo "This message will be printed to the user.";
?>
Los comentarios de PHP son la mejor práctica.
Para la revisión, use comentarios de una sola línea para notas cortas que expliquen el propósito de una función o línea de código, y comentarios de varias líneas para notas más largas, como una descripción más detallada de un bloque de código o una nota para otro desarrollador que puede eliminar más tarde.
En PHP (y otros lenguajes de codificación), los comentarios a menudo se subutilizan. Al principio, pueden parecer un paso innecesario que simplemente aumenta el volumen de sus archivos. Pero cuando comience a trabajar en equipo y a emprender proyectos complejos a largo plazo, ya debería adquirir el hábito de escribir comentarios; le ahorrará a usted y a los demás mucho tiempo tratando de entender las cosas.
