Se você estiver interessado em adicionar comentários de referência ao seu código XML, use este tutorial passo a passo para obter orientação. Você pode aprender como executar essa função em apenas cinco minutos. Embora o processo seja fácil de concluir, você ainda deve saber algumas noções básicas sobre comentários XML e sua utilidade antes de começar.
Por que os comentários XML são úteis?
Comentários em XML são quase idênticos aos comentários em HTML, pois ambos têm a mesma sintaxe. Usar comentários permite entender o código que você escreveu anos antes. Ele também pode ajudar outro desenvolvedor que está revisando o código desenvolvido para entender o que você escreveu. Em resumo, esses comentários fornecem contexto para o código.
Com comentários, você pode facilmente deixar uma nota ou remover temporariamente parte de um código XML. Mesmo que o XML seja projetado para ser "dados autoexplicativos", ocasionalmente, talvez seja necessário deixar um comentário XML.
Começando
As tags de comentário são compostas de duas partes: a parte que inicia o comentário e a parte que termina. Para começar, adicione a primeira parte da tag de comentário
Ao adicionar comentários de referência ao seu código XML, lembre-se de que eles não podem vir no topo do documento. Em XML, somente a declaração XML pode vir em primeiro lugar:
Como mencionado acima, os comentários não podem ser aninhados um dentro do outro. Você deve fechar seu primeiro comentário antes de abrir um segundo. Além disso, os comentários não podem ocorrer dentro de tags, por ex. Nunca use os dois traços (-) em qualquer lugar, exceto no início e no final dos seus comentários. Qualquer coisa nos comentários é efetivamente invisível para o analisador XML, portanto tenha muito cuidado para que o que resta ainda seja válido e bem formado. Se você ainda tiver dúvidas sobre como adicionar comentários de referência ao código XML, convém ler um livro para obter uma visão detalhada de como o processo funciona. Livros como "C # 5.0 Programmer's Reference" por Rod Stephens pode ser útil. Dicas úteis
Empacotando
