文章教程

17.3.4注释

9/17/2020 9:26:54 PM 人评论 次浏览

17.3.4 注释

XML文档中除了XML声明和XML元素这些主要内容之外,还有其他几项内容,本小节到17.3.6小节将向读者介绍这些内容。

注释可以出现在XML文档的任何位置,甚至可以出现在根元素的前面或后面。XML文档注释以<!--开始,以-->结束,这个用法和HTML一致。例如下面的XML代码片段中使用了注释。


01 <!--这些是图书的有关信息-->

02 <book>

03 <title>Learning PHP5</title><!--图书的名称-->

04 <author>David</author>

05 <publisher>White Water Press</publisher>

06 <price>29.90</price>

07 </book>

08 <!--图书信息结束-->


【代码解析】这段XML代码片段中加入了3处注释。

注意 在注释文本中不能出现“-”或“--”,因为XML处理器可能把它们和注释结尾标志“-->”相混淆。

不要把注释文本放在标记之中,如下代码所示。


<book<!--这些是图书的有关信息-->>

<title>Learning PHP5</title>

<author>David</author>

<publisher>White Water Press</publisher>

<price>29.90</price>

</book>


这段代码将注释“<!--这些是图书的有关信息-->“放在了标签<book>之中,这是错误的。同样的道理,不要将注释放在实体声明中,也不要放在XML声明之前。前面的内容讲过,XML声明永远是XML文件中的第一行。

注意 注释是不能嵌套使用的。

在使用一对注释符号表示注释文本时,要保证其中不再包含另一对注释符号。例如下面的例子就是不合法的。


<book>

<title>Learning PHP5</title>

<!--以下是图书作者的信息

<!--作者的姓名-->

-->

<author>David</author>

<publisher>White Water Press</publisher>

<price>29.90</price>

</book>


说明 XML解析器对于注释中的一切内容都会视而不见,注释中出现的标记也一同被忽略。这为除去XML文档中的一大部分元素提供了一种方法,可以将这部分元素使用注释括住。

教程类别