Si está interesado en añadir comentarios de referencia a su código XML, utilice este tutorial paso a paso como guía. Puede aprender a ejecutar esta función en sólo cinco minutos. Aunque el proceso es fácil de completar, antes de empezar debe conocer algunos aspectos básicos sobre los comentarios XML y su utilidad.
Índice de contenidos
Por qué son útiles los comentarios XML
Los comentarios en XML son casi idénticos a los comentarios en HTML, ya que ambos tienen la misma sintaxis. Usar comentarios te permite entender el código que escribiste años antes. También puede ayudar a otro desarrollador que esté revisando el código que usted desarrolló a entender lo que usted escribió. En resumen, estos comentarios proporcionan el contexto para el código.
Con los comentarios, puede dejar fácilmente una nota o eliminar temporalmente parte de un código XML. Aunque XML está diseñado para ser «datos autodescriptivos», en ocasiones puede ser necesario dejar un comentario XML.
Introducción
Las etiquetas de comentario se componen de dos partes: la parte que comienza el comentario y la parte que lo termina. Para empezar, añada la primera parte de la etiqueta de comentario
Consejos útiles
Al añadir comentarios de referencia a su código XML, recuerde que no pueden aparecer en la parte superior de su documento. En XML, sólo la declaración XML puede estar en primer lugar:
Como se mencionó anteriormente, los comentarios no pueden ser anidados uno dentro del otro. Debe cerrar su primer comentario antes de abrir un segundo. Además, los comentarios no pueden aparecer dentro de las etiquetas, por ejemplo,
.Nunca use los dos guiones (--) en ningún otro lugar excepto al principio y al final de sus comentarios. Cualquier cosa en los comentarios es efectivamente invisible para el analizador de XML, así que tenga mucho cuidado de que lo que queda sea válido y esté bien formado.
Envolviendo
Si todavía tiene preguntas sobre cómo añadir comentarios de referencia al código XML, puede que desee leer un libro para obtener una imagen detallada de cómo funciona el proceso. Libros como "C# 5.0 Programmer's Reference" de Rod Stephens pueden resultar útiles.
