Si está interesado en agregar 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 solo cinco minutos. Si bien el proceso es fácil de completar, aún debe conocer algunos conceptos básicos sobre los comentarios XML y su utilidad antes de comenzar.
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. Usando comentarios le permite comprender el código que escribió años antes. También puede ayudar a otro desarrollador que esté revisando el código que desarrolló a comprender lo que escribió. En resumen, estos comentarios proporcionan 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 es posible que deba dejar un comentario XML.
Empezando
Las etiquetas de comentario se componen de dos partes: la parte que comienza el comentario y la parte que lo termina. Para comenzar, agregue la primera parte de la etiqueta de comentario:
Luego escribe el comentario que quieras. Solo asegúrese de no anidar comentarios dentro de otros comentarios (consulte los consejos para obtener más detalles). Después de eso, cerrará la etiqueta de comentario:
-->
Consejos útiles
Cuando agregue comentarios de referencia a su código XML, recuerde que no pueden aparecer en la parte superior de su documento. En XML, solo la declaración XML puede ir primero:
Como se mencionó anteriormente, es posible que los comentarios no estén anidados unos dentro de otros. Debes cerrar tu primer comentario antes de abrir un segundo. Además, los comentarios no pueden aparecer dentro de las etiquetas, p. Ej.
.
Nunca use los dos guiones (-) en ningún otro lugar que no sea al principio y al final de sus comentarios. Cualquier cosa en los comentarios es efectivamente invisible para el Analizador XML, así que tenga mucho cuidado de que lo que queda siga siendo válido y esté bien formado.
Terminando
Si aún tiene preguntas sobre cómo agregar comentarios de referencia al código XML, es posible que desee leer un libro para obtener una imagen detallada de cómo funciona el proceso. Libros como"Referencia del programador de C # 5.0" por Rod Stephens puede resultar útil.