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é son los comentarios en programacion?

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 basan en una sintaxis particular de comentarios para generar la documentación de una aplicación de forma rápida. 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.

Tipos de comentarios en PHP

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.

Comentario lineal en PHP

A continuación te muestro un ejemplo de comentario en una línea, algo sencillo de hacer:

<?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 (//) y es un clásico de la programación.

La segunda opción es mediante el metacarácter almohadilla (#). Este último es menos utilizado en PHP.

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.

Ejemplo de comentario de múltiples líneas

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

Comentar funciones PHP

Uno de los usos más comunes y "profesionales" de los comentarios suele ser explicar la funcionalidad de una function PHP.

El siguiente código te sirve de guía para explicar funciones tanto en PHP como en otros lenguajes de programación y es parte de las buenas prácticas:

/**
  * Explicación de la función
  * @param NombreParametro y explicación
  * Pre: a tener en cuenta
  */
function hola(){
   return true;
}

Resumen para comentar en PHP

• Se pueden realizar comentarios de una línea o varias.
• Se puede comentar tanto lenguaje natural como código PHP.
• Los comentarios se suelen utilizar para explicar el código.
• Recuerda que existen estándares de colocación de comentarios para realizar documentaciones.
• Puedes