Si está interesado en agregar comentarios de referencia a su código XML, use este tutorial paso a paso como guía. Puedes aprender a ejecutar esta función en solo cinco minutos. Si bien el proceso es fácil de completar, aún debe saber algunos conceptos básicos sobre los comentarios XML y su utilidad antes de comenzar.
¿Por qué los comentarios XML son útiles?
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ó para entender lo que escribió. En resumen, estos comentarios proporcionan contexto para el código.
Con comentarios, puede dejar una nota fácilmente 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 comentarios constan de dos partes: la parte que comienza el comentario y la parte que lo finaliza. Para empezar, agregue la primera parte de la etiqueta de comentario
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 aparecer primero:
Como se mencionó anteriormente, los comentarios no pueden estar anidados uno dentro de otro. Debe cerrar su primer comentario antes de abrir un segundo. Además, los comentarios no pueden ocurrir dentro de las etiquetas, por ejemplo, Nunca use los dos guiones (-) en cualquier lugar, excepto 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 sea válido y esté bien formado. Si aún tiene preguntas sobre cómo agregar comentarios de referencia al código XML, puede leer un libro para obtener una imagen detallada de cómo funciona el proceso. Libros como La "Referencia del programador C # 5.0" por Rod Stephens puede resultar útil. Consejos útiles
Terminando
