XML作为一种标记语言，常被用来存储和传输数据，在文档中添加注释可以说明节点含义、标注修改记录，方便后续维护。XML注释有严格的语法规范，不符合规范的注释会导致XML解析失败。
XML注释的正确语法
XML注释的语法格式和HTML注释类似，以<!--开头，以-->结尾，注释内容写在两个标记之间。具体语法如下：
<!-- 这里是XML注释内容 -->
需要注意XML注释有以下语法限制：
- 注释不能出现在XML声明之前，XML声明必须是文档的第一行内容。
- 注释内容中不能包含
--字符串，否则会被解析器识别为注释结束标记，导致解析错误。 - 注释不能嵌套使用，即不能在一段注释内部再添加另一段注释。
- 注释不能放在标签的内部，比如不能写成
<user <!-- 用户名称 --> name="张三"/>这样的格式。
XML注释的使用场景
说明节点含义
当XML文档的节点名称不够直观时，可以添加注释说明节点的作用，方便其他开发者理解文档结构。示例如下：
<?xml version="1.0" encoding="UTF-8"?>
<user_info>
<!-- 用户基础信息节点，包含姓名、年龄、性别 -->
<base_info>
<name>张三</name>
<age>25</age>
<gender>男</gender>
</base_info>
<!-- 用户联系方式节点 -->
<contact_info>
<phone>13800138000</phone>
<email>test@ipipp.com</email>
</contact_info>
</user_info>
标注临时修改记录
如果需要临时屏蔽某段XML内容，或者标注修改的原因和时间，可以使用注释。示例如下：
<?xml version="1.0" encoding="UTF-8"?>
<config>
<!-- 2024年5月修改：新增日志级别配置 -->
<log_level>INFO</log_level>
<!-- 临时屏蔽旧版接口配置，待新版接口稳定后删除
<old_api_url>http://192.168.0.1:8080/api</old_api_url>
-->
<new_api_url>http://192.168.0.1:8081/api</new_api_url>
</config>
说明文档约束规则
在使用XML Schema或者DTD约束的文档中，可以添加注释说明约束规则，方便开发者遵循。示例如下：
<?xml version="1.0" encoding="UTF-8"?>
<!-- 订单文档约束说明：
1. 根节点必须为order
2. order必须包含order_id、product_list、total_price三个子节点
3. product_list至少包含一个product子节点
-->
<order>
<order_id>20240501001</order_id>
<product_list>
<product>
<product_name>笔记本电脑</product_name>
<price>5999</price>
</product>
</product_list>
<total_price>5999</total_price>
</order>
常见错误示例
以下是几种常见的XML注释使用错误，需要注意避免：
| 错误类型 | 错误代码示例 | 错误原因 |
|---|---|---|
| 注释在XML声明前 | <!-- 注释 --><?xml version="1.0"?> | XML声明必须是文档第一行内容 |
| 注释内容包含双短横线 | <!-- 用户--名称 --> | 注释内容中的--会被识别为结束标记 |
| 嵌套注释 | <!-- 外层注释 <!-- 内层注释 --> --> | XML不支持注释嵌套 |
| 标签内加注释 | <user <!-- 用户ID --> id="1"/> | 注释不能放在标签内部 |
注意事项
XML注释在解析时会被解析器忽略，不会作为文档内容被处理，因此不要把重要的业务数据放在注释中。另外，部分XML解析器在处理注释时可能存在差异，如果文档需要跨平台解析，建议尽量简化注释内容，避免出现特殊字符。如果需要注释包含特殊字符，可以使用CDATA段包裹注释内容，示例如下：
<!-- <![CDATA[ 这里可以包含特殊字符比如<>&等 ]]> -->
XMLXML_comment注释语法XML解析修改时间：2026-06-12 17:48:18