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 a 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
Os comentários em XML são quase idênticos aos comentários em HTML, pois ambos têm a mesma sintaxe. Usando comentários permite que você entenda o código que escreveu anos antes. Também pode ajudar outro desenvolvedor que está revisando o código que você desenvolveu a entender o que você escreveu. Resumindo, esses comentários fornecem contexto para o código.
Com os 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 autodescritivos", às vezes você pode precisar deixar um comentário XML.
Começando
As tags de comentário são compostas por duas partes: a parte que inicia o comentário e a parte que o termina. Para começar, adicione a primeira parte da tag de comentário:
Em seguida, escreva o comentário que desejar. Apenas certifique-se de não aninhar comentários dentro de outros comentários (veja dicas para mais detalhes). Depois disso, você fechará a tag de comentário:
-->
Dicas úteis
Ao adicionar comentários de referência ao seu código XML, lembre-se de que eles não podem vir na parte superior do seu documento. Em XML, apenas a declaração XML pode vir primeiro:
Conforme mencionado acima, os comentários não podem ser aninhados uns dentro dos outros. 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 exemplo,
.
Nunca use os dois travessões (-) em qualquer lugar, exceto no início e no final de seus comentários. Qualquer coisa nos comentários é efetivamente invisível para o Analisador XML, portanto, tome muito cuidado para que o que resta ainda seja válido e bem formado.
Empacotando
Se ainda tiver dúvidas sobre como adicionar comentários de referência ao código XML, você pode ler um livro para ter uma visão detalhada de como o processo funciona. Livros como"Referência do programador C # 5.0" por Rod Stephens pode ser útil.