欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  后端开发

XML中的代码注释书写方法的详解

程序员文章站 2022-03-10 09:18:30
...
这篇文章主要介绍了详解XML中的代码注释书写方法,文章中总结了注释使用的一些注意点,比如XML不支持嵌套注释等,需要的朋友可以参考下

XML 注释与 HTML 注释类似。注释被用来添加说明或者理解某行 XML 代码。

注释可以用来包含相关链接,信息和术语。它们只在源代码中可见,而不是 XML 代码中。注释可以出现在 XML 代码的任何地方。

语法
释以 <!-- 开始并以 --> 结束,例如 <!--catalog last updated 2016-02-14-->。
注释可以出现在文档序言中,包括文档类型定义 (DTD);文档之后;或文本内容中。 注释不能出现在属性值中。 不能出现在标记中。
分析器在遇到 > 时,就认为注释已结束;然后继续将文档作为正常的 XML 处理。 因此,字符串 > 不能出现在注释中。 除了该限制之外,任何合法的 XML 字符均可以出现在注释中,与 CDATA 节非常类似。 这样,可以从分析器看到的输出流中删除 XML 注释,同时又不会删除文档的内容。
以下注释可以用于暂时除去标记。

示例
下面是在 XML 文档中使用注释的一个演示示例:

<?xml version="1.0" encoding="UTF-8" ?>
<!---Students grades are uploaded by months---->
<class_list>
    <student>
        <name>Tanmay</name>
        <grade>A</grade>
    </student>
</class_list>

注意

字符之间的文本都被视为注释。 ## XML 注释规则 下面是 XML 注释需要遵循的规则:
- 注释不能出现在 XML 声明之前。
- 注释可以出现在文档的任何位置。
- 注释不能出现在属性值中。
- 注释不能嵌套在其他注释中。

在 HTML 中,可以使用注释来隐藏脚本和样式表。 若要在 XML 中使用此方法,可能必须检索注释,提取注释的内容,检查是否有标记字符,然后再进行重新分析。 在此例中,CDATA 节是更好的选择。

以上就是XML中的代码注释书写方法的详解的详细内容,更多请关注其它相关文章!

相关标签: XML 注释