Tipos de comentarios de programación PHP

Como en cualquier otro lenguaje de programación, PHP tiene su propia sintaxis de comentarios.

Hay varios tipos de comentarios de PHP que detallaremos. Los comentarios son parte de los elementos triviales en el éxito de un programa, y es por eso que es importante utilizarlos de manera inteligente.

¿Qué es un comentario?

Un comentario, en un lenguaje de programación, es una línea escrita en un lenguaje natural (el lenguaje nativo del desarrollador, por ejemplo) que no será ejecutada por el intérprete (o el compilador, según el lenguaje utilizado).

Su función es describir o explicar una parte del código que sería difícil de descifrar en caso de mantenimiento o trabajo en colaboración (varios desarrolladores trabajando en el mismo programa).

Por lo tanto, los comentarios son particularmente útiles para un desarrollador solitario, pero son más útiles cuando se trata de un equipo completo que trabaja en el mismo proyecto. Entre otras cosas, permiten imponer nomenclaturas y organización al escribir código para un proyecto de colaboración. Además, los comentarios aseguran un mantenimiento más fácil del programa por parte de su autor o de un tercero.

Otro punto fuerte de los comentarios es la generación de documentación técnica. De hecho, hay aplicaciones como PHPDocumentor que se basa en una sintaxis particular de comentarios para generar la documentación de una aplicación. Esto asegura un ahorro de tiempo significativo para un equipo de desarrollo.

Comentar un código es también parte de las buenas prácticas a adoptar en la programación. Sin embargo, no se debe entrar en el exceso opuesto donde cada instrucción del código se comentaría. Entonces se lograría la claridad y la legibilidad del programa.

Comentario lineal

Hay dos tipos de comentarios. El comentario de una sola línea y el comentario de varias líneas. Estudiemos juntos los dos métodos para comentar un texto en una sola línea.

<?php
 
  // Este es el primer comentario lineal
  echo 'Hello World !';
 
  # Este es otro comentario lineal
  echo 'Buenos días mundo, desde srcodigofuente.es!!';
 
?>

PHP ofrece dos formas de comentar el texto colocado en una línea. El método más utilizado es el primero con doble barra (//) en lugar del segundo con el signo de hachís (#).

Comentarios de múltiples líneas

Permite comentar un texto escrito en varias líneas. Es muy utilizado por los desarrolladores. Estos comentarios se definen mediante los símbolos /* y */. El siguiente ejemplo ilustra su utilización.

<?php
  /*
    Este es un comentario escrito en sublime text
  
   El siguiente código muestra el mensaje hola mundo.
  */
  echo 'Hello World !';
?>

Hemos definido lo que es un comentario y cómo se utiliza dependiendo de si es lineal o multilínea. Por lo tanto, es importante recordar que siempre los usen en sus programas para asegurar una fácil revisión y mantenimiento de su código.

Sobre el autor

Javier Gómez

Ingeniero técnico en informática de gestión. Desarrollador web freelance y profesor de desarrollo web a partes iguales. Testarudo autodidacta, creativo, perfeccionista y alma libre.