Cómo comentar una línea en XML

Programador trabajando con código de programa

A diferencia de HTML, las etiquetas XML proporcionan detalles descriptivos sobre el contenido en lugar de instrucciones visuales para mostrarlo.

Credito de imagen: RossHelen / iStock / GettyImages

XML proporciona un lenguaje de marcado para almacenar datos y transmitirlos de una ubicación a otra. Al igual que HTML, utiliza texto sin formato que puede editar en cualquier aplicación que escriba archivos TXT. A diferencia de HTML, las etiquetas XML proporcionan detalles descriptivos sobre el contenido en lugar de instrucciones visuales para mostrarlo. A medida que define etiquetas XML para caracterizar un conjunto de información, puede utilizar comentarios para servir dos propósitos dentro de su trabajo: explicarlo y omitir partes del código que otras aplicaciones proceso. Si ya conoce la sintaxis de comentarios HTML, también conoce el equivalente XML.

Si desea comentar una sola línea en el código XML, inserte el cursor al principio de una línea que desee comentar. Escribe un símbolo menor que seguido de un signo de exclamación y dos guiones

. Mueva el cursor al final de la línea y luego escriba dos guiones seguidos de un símbolo mayor que.

Video del día

Si su línea consta de la declaración "Use esta sección para crear una descripción de gatos adoptables", se verá así con ambas etiquetas de comentario en su lugar:

Querrá leer su comentario para verificar que no contiene ninguna instancia de dos guiones consecutivos que no sean sus etiquetas de comentarios de apertura y cierre. Los guiones consecutivos desencadenan una señal falsa de fin de comentario que interrumpe su sintaxis.

En lugar de simplemente comentar una sola línea, es posible que deba comentar una sección completa de su código XML. Para hacer esto, inserte el cursor en una línea en blanco encima de la sección del código XML que desea comentar y luego escriba un símbolo menor que seguido de un signo de exclamación y dos guiones.

Para finalizar el comentario, mueva el cursor hacia abajo a una línea en blanco después de la sección de código XML que está comentando. Escribe dos guiones seguidos de un símbolo mayor que. Con los comentarios en su lugar, una sección de código XML se ve así:

Nuevamente, querrá leer su sección comentada para verificar que no contiene un comentario dentro de las líneas que comentó. Los comentarios anidados constituyen un error en XML.

Al hacer comentarios, recuerde algunas reglas básicas de sintaxis XML. XML no permite el uso del carácter menor que dentro de su código, excepto como parte de una etiqueta de comentario de apertura. Para incluir el personaje en cualquier cosa que no sea una etiqueta de comentario, introdúzcalo como referencia de entidad, una secuencia codificada que se convierte en un carácter específico cuando una aplicación analiza su XML.

Cada referencia de entidad comienza con un ampersand y termina con un punto y coma. Entre esos dos caracteres, la referencia de entidad para el símbolo menor que contiene las letras minúsculas "lt", sin las comillas ni la puntuación. El símbolo mayor que no constituye un carácter ilegal en XML, pero es una buena práctica utilizar también su referencia de entidad, que incluye las letras "gt".

Además, sepa que si no abre y cierra sus comentarios correctamente, o los coloca alrededor de una sección de código que contiene una ID, su XML no se analizará correctamente.