如何将参考注释添加到您的XML代码

通过这个循序渐进的指南获取事实

如果您有兴趣将参考注释添加到您的XML代码中,请使用此分步教程获取指导。 您可以学习如何在短短五分钟内执行此功能。 虽然这个过程很容易完成,但在开始之前,您仍应该了解一些关于XML注释及其用途的基础知识。

为什么XML注释有用

XML中的注释与HTML中的注释几乎相同,因为它们都具有相同的语法。 使用注释可以让你理解你以前写过的代码。 它还可以帮助正在审阅您开发的代码的其他开发人员了解您所写的内容。 简而言之,这些评论为代码提供了上下文。

通过评论,您可以轻松留下笔记或暂时删除部分XML代码。 尽管XML被设计为“自我描述数据”,但有时您可能需要留下XML注释。

入门

注释标签由两部分组成: 开始评论的部分和结束部分。 首先,添加注释标记的第一部分<! - 然后写出您想要的任何评论 。 只要确保你不要在其他评论中嵌套评论(更多细节参见提示)。

之后,您将关闭评论标签 - >

有用的提示

在向XML代码添加引用注释时,请记住它们不能位于文档的顶部。 在XML中,只有XML声明可以优先:

<?xml version =“1.0”?>

如上所述,评论可能不会嵌套在另一个之内。 在打开第二个评论之前,您必须关闭您的第一条评论。 另外,标签内不能出现注释,例如

切勿在评论的开头和结尾使用两个破折号( - )。 注释中的任何内容对XML解析器来说都是不可见的,所以要非常小心,仍然有效并且格式良好。

包起来

如果您仍然有关于向XML代码添加参考注释的问题,您可能需要阅读一本书,以便详细了解该过程的工作原理。 诸如Rod Stephens的C#5.0程序员参考书籍可能会有帮助。 查看网上零售商或当地图书馆是否有类似的书籍。