Como comentar uma linha em XML

click fraud protection
Programador trabalhando com código de programa

Ao contrário do HTML, as tags XML fornecem detalhes descritivos sobre o conteúdo, em vez de instruções visuais para exibi-lo.

Crédito da imagem: RossHelen / iStock / GettyImages

XML fornece uma linguagem de marcação para armazenar dados e transportá-los de um local para outro. Como o HTML, ele usa texto simples que pode ser editado em qualquer aplicativo que grave arquivos TXT. Ao contrário do HTML, as tags XML fornecem detalhes descritivos sobre o conteúdo, em vez de instruções visuais para exibi-lo. Ao definir tags XML para caracterizar um conjunto de informações, você pode usar comentários para servir a dois objetivos em seu trabalho: explicá-lo e omitir partes dele do código que outros aplicativos processo. Se você já conhece a sintaxe de comentário HTML, também conhece o equivalente em XML.

Se você deseja comentar uma única linha no código XML, insira o cursor no início da linha que deseja comentar. Digite um símbolo de menor que seguido por um ponto de exclamação e dois travessões

. Mova o cursor para o final da linha e digite dois travessões seguidos de um símbolo de maior que.

Vídeo do dia

Se sua linha consistir na declaração "Use esta seção para construir uma descrição de gatos adotáveis", ela se parecerá com isto com ambas as tags de comentário no lugar:

Você vai querer ler seu comentário para verificar se ele não contém nenhuma instância de dois travessões consecutivos além das tags de comentário de abertura e fechamento. Traços consecutivos acionam um sinal de fim de comentário falso que interrompe sua sintaxe.

Em vez de apenas comentar uma única linha, pode ser necessário comentar uma seção inteira de seu código XML. Para fazer isso, insira o cursor em uma linha em branco acima da seção do código XML que deseja comentar e digite um símbolo de menor que seguido por um ponto de exclamação e dois travessões.

Para encerrar o comentário, mova o cursor para baixo até uma linha em branco após a seção do código XML que você está comentando. Modelo dois travessões seguidos de um símbolo de maior que. Com os comentários no lugar, uma seção do código XML se parece com isto:

Novamente, você vai querer ler sua seção comentada para verificar se ela não contém um comentário dentro das linhas que você comentou. Os comentários aninhados constituem um erro em XML.

Ao fazer comentários, lembre-se de algumas regras básicas de sintaxe XML. XML não permite o uso do caractere menor que em seu código, exceto como parte de uma tag de comentário de abertura. Para incluir o caractere em qualquer coisa, exceto uma tag de comentário, insira-o como um referência de entidade, uma sequência codificada que se transforma em um caractere específico quando um aplicativo analisa seu XML.

Cada referência de entidade começa com um "e" comercial e termina com um ponto e vírgula. Entre esses dois caracteres, a referência da entidade para o símbolo de menos que contém as letras minúsculas "lt", sem as aspas e pontuação. O símbolo maior que não constitui um caractere ilegal em XML, mas é uma boa prática usar sua referência de entidade também, que inclui as letras "gt."

Além disso, saiba que se você não conseguir abrir e fechar seus comentários corretamente, ou colocá-los em torno de uma seção do código que contém um ID, seu XML não será analisado corretamente.