Aprende las formas de comentar en React

| Última modificación: 28 de mayo de 2024 | Tiempo de Lectura: 3 minutos

Algunos de nuestros reconocimientos:

Premios KeepCoding

Los comentarios son una herramienta fundamental para cualquier desarrollador. Comentar en React nos permite documentar nuestro código, explicar la lógica detrás de nuestras decisiones y ayudar a otros (o a nuestro futuro yo) a entender lo que hemos hecho. Sin embargo, cuando trabajamos con React y su sintaxis JSX, los comentarios pueden no ser tan intuitivos como en otros lenguajes. En este artículo, aprenderás las diferentes formas de comentar en React y cómo aplicarlas correctamente.

Comentar en React fuera del renderizado del componente

Si necesitas escribir un comentario fuera del renderizado de un componente, puedes usar la sintaxis de JavaScript sin ningún problema. Aquí tienes un ejemplo:

//comentar en React
function Button({ text }) {
  // Esto es un comentario
  /* Esto es un comentario
  de varias líneas */

  return (
    <button>
      {text}
    </button>
  );
}

Esta forma de comentar es útil para explicar la lógica antes de que el componente se renderice.

Comentar en React dentro del renderizado del componente

Cuando necesitas comentar dentro del renderizado de un componente, la cosa cambia un poco. Aquí debes usar siempre la sintaxis de comentarios de bloque de JavaScript y envolverlos en llaves {} para que JSX los entienda correctamente:

//comentar en React
function Button({ text }) {
  return (
    <button>
      {/* Esto es un comentario en el render */}
      {text}
    </button>
  );
}

Comentarios HTML o JavaScript en JSX

Podrías pensar que, dado que JSX se parece tanto a HTML, podrías usar la sintaxis de comentarios HTML. Sin embargo, esto no funcionará y provocará errores. Aquí tienes un ejemplo de lo que NO debes hacer:

//comentar en React
const MiComponente = () => {
  return (
    <div>
      <p>¡Hola, mundo!</p>
      <!-- Esto sería un comentario HTML -->
    </div>
  );
};

Tampoco puedes usar la sintaxis de comentarios de una sola línea de JavaScript directamente dentro del JSX:

//comentar en React
const MiComponente = () => {
  return (
    <div>
      // Este no es un comentario JSX
      <p>¡Hola, mundo!</p>
    </div>
  );
};

La forma correcta de insertar comentarios en JSX

Para comentar en JSX de manera adecuada, debes usar llaves {} y la sintaxis de comentarios de bloque de JavaScript:

//comentar en React
const MiComponente = () => {
  return (
    <div>
      {// Esto sí es un comentario JSX
      }
      <p>¡Hola, mundo!</p>
      {/*
          También podemos tener
          comentarios multilínea
      */}
    </div>
  );
};

Nota importante:

Al escribir un comentario en línea, asegúrate de que la llave de cierre } esté en una nueva línea. De lo contrario, se evaluarán las siguientes líneas como código JavaScript, lo que provocará un error.

Usar comentarios JSX para eliminar partes de la UI

Una de las ventajas de los comentarios en JSX es que puedes eliminar temporalmente partes de la interfaz de usuario sin borrar el código. Aquí tienes un ejemplo:

const MiComponente = () => {
  return (
    <div role="search">
      <form>
        <input type="search" />
        {/* <button type="submit">Buscar</button> */}
      </form>
    </div>
  );
};

¿Por qué comentar en React JSX?

Al igual que en cualquier otro lenguaje de programación, el proceso de comentar en React JXS nos ayuda a:

  • Explicar funcionalidades complejas: Los comentarios nos permiten documentar partes complicadas del código, facilitando su comprensión.
  • Documentar el código: Ayuda a que otros desarrolladores puedan entender y mantener el código con facilidad.
  • Eliminar temporalmente partes del código: Podemos comentar secciones de código para deshabilitarlas sin necesidad de borrarlas.

Comentar en React es esencial para mantener tu código claro y fácil de entender. Ya sea que necesites explicar una lógica compleja, documentar tu código o deshabilitar temporalmente partes de la interfaz, los comentarios son una herramienta invaluable.

Si te apasiona el desarrollo web y quieres llevar tus habilidades al siguiente nivel, apúntate a nuestro Bootcamp en desarrollo web de KeepCoding. Aprenderás todo lo necesario para convertirte en un profesional del sector tecnológico, con acceso a una industria en constante crecimiento, altos salarios y estabilidad laboral. ¡Da el paso y transforma tu vida con KeepCoding! Únete a nosotros y conoce la mejor comunidad tech.

Alberto Casero

Alberto Casero es CTO en Watium, Fundador de Kas Factory & Coordinador del Bootcamp en Desarrollo Web.

Posts más leídos

¡CONVOCATORIA ABIERTA!

Desarrollo Web

Full Stack Bootcamp

Clases en Directo | Profesores en Activo | Temario 100% actualizado