Skip to main content

向XML代码添加引用注释

Anonim

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

为什么XML注释很有用

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

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

入门

评论标签由两部分组成:开始评论的部分和结束评论的部分。首先,添加注释标记的第一部分

有用的提示

在XML代码中添加引用注释时,请记住它们不能位于文档的最顶层。在XML中,只能首先使用XML声明:

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

.

切勿在评论的开头和结尾处使用两个破折号( - )。注释中的任何内容对于XML解析器实际上是不可见的,因此要非常小心,剩下的内容仍然有效并且格式正确。

包起来

如果您仍然对向XML代码添加引用注释有疑问,可能需要阅读一本书,以便详细了解该过程的工作原理。书籍如 罗德斯蒂芬斯的“C#5.0程序员参考”可能会有所帮助。