Comment commenter un bloc de balises en XML ?

Question

Comment commenter un bloc de balises en XML ?

Par exemple, comment puis-je commenter <staticText> et tout ce qu'il contient, dans le code ci-dessous ?

  <detail>
    <band height="20">
      <staticText>
        <reportElement x="180" y="0" width="200" height="20"/>
        <text><![CDATA[Hello World!]]></text>
      </staticText>
    </band>
  </detail>

Je pourrais utiliser <!-- staticText--> mais c'est seulement pour les balises uniques (d'après ce que je sais), par exemple // en Java et en C. Je voudrais quelque chose qui ressemble plus à la façon dont /** comment **/ peut être utilisé en Java et en C, ce qui me permet de commenter de longs blocs de code XML.

Answer 1

Vous pouvez utiliser ce style de commentaire sur plusieurs lignes (qui existe aussi en HTML).

<detail>
    <band height="20">
    <!--
      Hello,
         I am a multi-line XML comment
         <staticText>
            <reportElement x="180" y="0" width="200" height="20"/>
            <text><![CDATA[Hello World!]]></text>
          </staticText>
      -->
     </band>
</detail>

Answer 2

Vous pouvez envelopper le texte avec une instruction de traitement inexistante, par exemple :

<detail>
<?ignore
  <band height="20">
    <staticText>
      <reportElement x="180" y="0" width="200" height="20"/>
      <text><![CDATA[Hello World!]]></text>
    </staticText>
  </band>
?>
</detail>

Les instructions de traitement imbriquées ne sont pas autorisées et '?>' met fin à l'instruction de traitement (cf. http://www.w3.org/TR/REC-xml/#sec-pi )

Answer 3

Si vous demandez, parce que vous avez obtenu des erreurs avec le <!-- --> il s'agit très probablement de la section CDATA (et là, la section ]]> ), qui se trouve alors au milieu du commentaire. Il s'agit de debe Cela ne fait pas de différence, mais l'idéal et le monde réel peuvent parfois être très éloignés l'un de l'autre (surtout en ce qui concerne le traitement XML).

Essayez de changer le ]]> aussi :

  <!--detail>
    <band height="20">
      <staticText>
        <reportElement x="180" y="0" width="200" height="20"/>
        <text><![CDATA[Hello World!]--><!--]></text>
      </staticText>
    </band>
  </detail-->

Une autre chose, qui me vient à l'esprit : Si le contenu de votre XML contient quelque part deux traits d'union, le commentaire s'arrête immédiatement là :

<!-- <a> This is strange -- but true!</a> -->
--------------------------^ comment ends here

C'est un piège assez courant. Il est hérité de la façon dont SGML gère les commentaires. ( Lisez la spécification XML à ce sujet )

Answer 4

En fait, vous pouvez utiliser le format <!--...--> avec des lignes ou des balises multiples :

<!--
  ...
  ...
  ...
-->

Answer 5

Vous devez savoir que les commentaires dans un fichier xml sont considérés comme des nœuds de type XmlComment, donc si vous chargez le fichier xml, ces nœuds vont être chargés et c'est à vous de les éviter ou de les filtrer lors de l'analyse du contenu chargé.