HTML - Comentarios

Mateo G. -

Sintaxis de los comentarios en HTML

En HTML, los comentarios se hacen utilizando una sintaxis que indica al navegador que ignore el texto dentro de las etiquetas de comentario. Esto permite a los desarrolladores añadir notas, explicaciones o desactivar temporalmente partes del código sin cambiar la salida de la página web.

Para hacer un comentario en HTML, utiliza la etiqueta de apertura <!-- y la etiqueta de cierre -->. Cualquier texto entre estas etiquetas será un comentario y no se mostrará en la página web.

Consejo: Sintaxis para un comentario en HTML

<!-- Esto es un comentario en HTML -->

Puedes poner comentarios en cualquier parte del código HTML, ya sea en su propia línea o en línea con otros elementos HTML. No anides comentarios dentro de otros, ya que esto puede causar un comportamiento inesperado.

Consejo: Colocación de comentarios dentro del código HTML

<!-- Este comentario está en su propia línea -->
<p>Este es un párrafo.</p>

<p>Este es otro párrafo con un <!-- comentario en línea --> dentro de las etiquetas.</p>

<!-- 
    Este es un comentario 
    de varias líneas 
    que se extiende por 
    múltiples líneas
-->

Al usar comentarios, mantenlos breves y relacionados con el código que los rodea. Deben proporcionar información útil para otros desarrolladores (o para ti mismo) que puedan necesitar entender o mantener el código más adelante.

Tipos de comentarios HTML

Los comentarios HTML pueden ser de una sola línea o de varias líneas, según las necesidades del desarrollador. Ambos tipos siguen la misma sintaxis básica pero difieren en cómo se formatean dentro del código.

Comentarios de una sola línea

Los comentarios de una sola línea se usan para notas o explicaciones breves que caben en una línea. Para crear un comentario de una sola línea, use la etiqueta de apertura <!-- y la etiqueta de cierre --> en la misma línea.

Consejo: Comentario de una sola línea

<!-- Esto es un comentario de una sola línea -->

Los comentarios de una sola línea se usan con mayor frecuencia para descripciones cortas de secciones de código o para deshabilitar temporalmente elementos HTML individuales.

Consejo: Ejemplo de un menú de navegación con comentarios de una sola línea

<!-- El menú de navegación comienza aquí -->
<nav>
  <ul>
    <li><a href="#">Inicio</a></li>
    <li><a href="#">Acerca de</a></li>
    <li><a href="#">Contacto</a></li>
  </ul>
</nav>
<!-- El menú de navegación termina aquí -->

Comentarios de varias líneas

Cuando necesita escribir comentarios más largos que abarcan varias líneas, use comentarios de varias líneas. Estos comentarios también comienzan con <!-- y terminan con -->, pero el texto entre las etiquetas puede estar en varias líneas.

Consejo: Comentario de varias líneas

<!--
  Este es un comentario de varias líneas
  que puede extenderse a través de
  múltiples líneas en el código HTML
-->

Los comentarios de varias líneas son útiles para proporcionar explicaciones más detalladas de secciones de código o para deshabilitar temporalmente bloques más grandes de código HTML.

Consejo: Comentario de varias líneas deshabilitando una sección HTML

<!--
<section>
  <h2>Esta sección está actualmente en desarrollo</h2>
  <p>Por favor, vuelva más tarde para ver las actualizaciones.</p>
</section>
-->

Al usar comentarios de una sola línea y de varias líneas de manera apropiada, los desarrolladores pueden crear código HTML claro y bien documentado que sea más fácil de entender y mantener.