Obter os feitos con esta guía paso a paso
Se estás interesado en engadir comentarios de referencia ao teu código XML, utiliza este tutorial paso a paso para obter orientación. Podes aprender a executar esta función en só cinco minutos. Aínda que o proceso sexa fácil de completar, aínda debes saber algúns conceptos básicos sobre comentarios XML e a súa utilidade antes de comezar.
Por que os comentarios XML son útiles
Os comentarios en XML son case idénticos aos comentarios en HTML, xa que ambos teñen a mesma sintaxe. Usar comentarios permítelle entender o código que escribiu anos antes. Tamén pode axudar a outro desenvolvedor que estea a revisar o código que desenvolveu e entender o que escribiu. En definitiva, estes comentarios proporcionan contexto para o código.
Con comentarios, pode facilmente deixar unha nota ou eliminar unha parte dun código XML. Aínda que o XML está deseñado para ser "datos de auto-descrición", en ocasións pode ter que deixar un comentario XML.
Comezando
As etiquetas de comentarios están compostas por dúas partes: a parte que comeza o comentario ea parte que remata. Para comezar, engade a primeira parte da etiqueta de comentario o comentario que desexe. Só asegúrate de non anidar comentarios noutros comentarios (consulta consellos para máis detalles).
Despois diso, pecharás a etiqueta do comentario ->
Consellos útiles
Ao agregar comentarios de referencia ao seu código XML, lembre que non poden vir na parte superior do documento. En XML, só a declaración XML pode vir primeiro:
Como se mencionou anteriormente, os comentarios non se poden anidar dentro doutro. Debes pechar o teu primeiro comentario antes de abrir un segundo. Ademais, os comentarios non poden ocorrer dentro de etiquetas, por exemplo,
Nunca empregue os dous guións (-) en calquera lugar, pero ao comezo e ao final dos teus comentarios. Calquera cousa nos comentarios é efectivamente invisible para o analizador XML, así que teña moito coidado de que o que queda sexa aínda válido e ben formado.
Envoltando
Se aínda ten dúbidas sobre a adición de comentarios de referencia ao código XML, pode que queira ler un libro para darlle unha imaxe detallada de como funciona o proceso. Libros como a referencia de programador C # 5.0 por parte de Rod Stephens poden ser útiles. Consulta os venda polo miúdo en liña ou a túa biblioteca local para libros similares.