Comentarios en XML

Los comentarios en XML permiten agregar notas, explicaciones o documentación interna dentro del archivo, sin que estas afecten al contenido ni a la validación del documento.

Sirven para:

  • Explicar la finalidad de ciertos elementos o atributos.
  • Marcar secciones del documento.
  • Dejar recordatorios o notas para otros desarrolladores.

1. Sintaxis de un comentario

Un comentario en XML se escribe así:

<!-- Este es un comentario -->

Reglas básicas:

  • Comienza con <!-- y termina con -->.
  • No puede contener -- en su interior (es inválido).
  • Puede estar en cualquier parte del documento, salvo dentro de la declaración XML.

2. Ejemplos de comentarios

a) Comentario simple

<!-- Lista de libros de la biblioteca -->
<biblioteca>
    <libro>Don Quijote</libro>
    <libro>La Odisea</libro>
</biblioteca>

b) Comentario en una línea dentro del contenido

<biblioteca>
    <libro>Don Quijote</libro> <!-- Obra española -->
    <libro>La Odisea</libro>   <!-- Obra griega -->
</biblioteca>

c) Comentarios multilínea

<!-- 
    Archivo XML de ejemplo.
    Contiene datos de empleados.
    Cada empleado tiene: id, nombre y área.
-->
<empresa>
    <empleado id="1">
        <nombre>Laura</nombre>
        <area>Ventas</area>
    </empleado>
</empresa>

3. Dónde se pueden colocar

Lugares permitidos:

  • Antes del elemento raíz.
  • Dentro del elemento raíz, entre elementos.
  • Al final del documento.

Lugares no permitidos:

  • Dentro de la declaración XML:
<?xml version="1.0" encoding="UTF-8"?> <!-- Inválido aquí -->

4. Buenas prácticas con comentarios

  • Usarlos para explicar el contenido, no para guardar información que debería estar en el XML.
  • Mantenerlos claros y breves.
  • Colocarlos en lugares estratégicos (antes de secciones importantes).
  • Usarlos para dividir bloques grandes de XML:
<!-- ======================
     Sección de clientes
====================== -->
<clientes>
    <cliente id="101">
        <nombre>Juan</nombre>
        <ciudad>Córdoba</ciudad>
    </cliente>
</clientes>

Documentar estructuras complejas:

<!-- 
   El elemento "pedido" contiene:
   - id (atributo)
   - fecha (atributo)
   - productos (elementos hijos)
-->
<pedido id="5001" fecha="2025-09-09">
    <producto>Computadora</producto>
    <producto>Mouse</producto>
</pedido>

5. Malas prácticas con comentarios

  • Usar comentarios para desactivar información en producción de forma permanente.
<!-- <usuario activo="false"/> -->

Esto puede generar confusión si alguien piensa que el elemento nunca existió.

  • Guardar datos importantes en comentarios.
<!-- La contraseña es 1234 -->

Nunca se deben dejar credenciales o información sensible en un comentario.

  • Uso excesivo que ensucia el archivo.

Los comentarios son útiles, pero si hay demasiados, dificultan la lectura.

6. Ejemplo completo con comentarios

<?xml version="1.0" encoding="UTF-8"?>

<!-- 
    Ejemplo de archivo XML con comentarios
    Curso de XML - Tema 7
-->

<biblioteca>
    <!-- Primer libro en español -->
    <libro id="1" idioma="es">
        <titulo>Don Quijote</titulo>
        <autor>Miguel de Cervantes</autor>
    </libro>
    
    <!-- Segundo libro, clásico griego -->
    <libro id="2" idioma="gr">
        <titulo>La Odisea</titulo>
        <autor>Homero</autor>
    </libro>
</biblioteca>

7. Resumen didáctico

  • Los comentarios se escriben con <!-- ... -->.
  • No pueden contener -- en su interior.
  • Sirven para documentar y explicar partes del XML.
  • Buenas prácticas: claros, breves y estratégicos.
  • Malas prácticas: usarlos como "basurero" de datos o llenarlos de información innecesaria.

Con comentarios bien usados, un archivo XML se vuelve más legible y mantenible, sobre todo en proyectos grandes con varios desarrolladores.

Retornar