2.2.5 注释

2.2.5 注释
   

象前一节的例子中那样，有些时候，你希望XML处理器能够把你在数据中引入的标记当作普通数据而不是真正的标记来看待。这时，CDATA为你助了一臂之力。另外还有些时候，就象在程序中引入注释一样，你可能希望在XML文件中加入一些用作解释的字符数据，并且希望XML处理器不对它们进行任何处理。这种类型的文本称作注释（COMMENT）文本。
在HTML中，注释是用“〈！--”和“--〉”引起来的。在XML中，注释的方法完全相同，看起来非常亲切。因此，下面是一个合法的XML文件：
<示例>
    <-- 一个XML的例子 -->
    <[CDATA[
        <姓名>张三
        [email]zhang@aaa.com[/email]
        
    ]]>

不过，在XML文件中使用注释时，同样要遵守几个规则：
在注释文本中不能出现字符“-”或字符串“--”，XML处理器可能把它们和注释结尾标志“-->”相混淆。
不要把注释文本放在标记之中，否则，它就不是一个“形式良好的”XML文件了。例如下面这段代码：

<示例    <-- 一个XML的例子 --> >
    <[CDATA[
        <姓名>张三
        [email]zhang@aaa.com[/email]
        
    ]]>

类似地，不要把注释文本放在实体声明中，也不要放在XML声明之前。记住，永远用XML声明作为XML文件中的第一行。
注释不能被嵌套。在使用一对注释符号表示注释文本时，要保证其中不再包含另一对注释符号。例如下面例子是不合法的：

<-- 一个XML的例子 -->
最后再重申一遍，XML处理器对于注释中的一切内容都会视而不见，注释中出现的标记也一同被忽略。因此，在下面这段文本中，所有注释中的“名词”元素都被忽略，剩下的只有最后一行中的元素“XML”。
<-- 不处理以下信息HTML
        <名词>XHTML
        <名词>SGML
-->
<名词>XML
不过，当使用注释时一定要小心，要确保文件在去掉全部注释之后，遵守所有“形式良好的”文件的要求。