如何在XML中注释单行?

时间:2013-06-26 17:52:04

标签: xml xml-comments

这是一个不容错过的验证。

XML中是否存在行注释?所以,没有更接近的,就像编译器使用的“//”。

我看到How do I comment out a block of tags in XML?和其他几个讨论。

这种类型的评论可以用来评论一条线而不会在某处向某处打扰。

5 个答案:

答案 0 :(得分:134)

不,没有办法在XML中注释一行,并且会在换行符上自动结束注释。

XML只有one definition for a comment

'<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

XML禁止在评论中--维护compatibility with SGML

答案 1 :(得分:18)

正如其他人所说,没有办法在XML中单行注释合法注释多行但是,有办法发表评论XML片段更容易。查看下面的示例,如果添加“&gt;”在第一行,XmlTag将被取消注释。删除'&gt;'它再次被评论出来。这是我见过的最简单的方法,可以快速评论/取消注释XML而不会破坏事物。

<!-- --
<XmlTag variable="0" />
<!-- -->

额外的好处是你只能操纵最高评论,而底部评论可以永远坐在那里。这打破了与SGML的兼容性,一些XML解析器会对它进行限制。只要这不是XML中的永久固定,并且解析器接受它,它就不是真正的问题。 StackOverflow和Notepad ++的语法高亮显示器将其视为多行注释,C ++的boost库将其视为多行注释,而迄今为止我发现的唯一解析器是.Net中的解析器,特别是C#。因此,在使用之前,请务必首先测试您的工具,IDE,库,语言等是否接受它。

如果您关心SGML兼容性,只需使用它:

<!-- -
<XmlTag variable="0" />
<!- -->

添加' - &gt;'到顶部评论和底部评论' - '。每个时候都需要编辑底部注释,这可能会让您更容易在顶部输入<!--,每次在底部输入-->

我还想提一下,其他评论者建议使用XML编辑器,它允许您右键单击并注释/取消注释XML块,这可能比花哨的查找/替换技巧更好(它也可以得到一个很好的答案本身,但我从来没有使用过这样的工具。我只想确保信息不会随着时间的推移而丢失。我个人从来没有足够的处理XML来证明编辑器比Notepad ++更有价值,所以这完全取决于你。

答案 2 :(得分:9)

它与HTML或javascript块注释相同

<!-- to be commented xml block goes here -->

答案 3 :(得分:5)

不正统,但有时对我有用;将您的评论设置为另一个属性

<node usefulAttr="foo" comment="your comment here..."/>

答案 4 :(得分:4)

Extensible Markup Language (XML) 1.0仅包含阻止评论。