如何插入VS XML注释代码

。C# 允许开发人员在源代码中插入VS XML注释，这在多人协作开发的时候显得特别有用。 C#分析器可以把代码文件中的这些XML标记提取出来，并作进一步的处理为外部文档。 这篇文章将展示如何 运用这些VS XML注释。作者演示了如何 生成工程，如何 把VS XML注释输出为有用文档，如何 把这些注释转变为帮助文件。 在项目开发中，很多人并不乐意写繁杂的文档。但是，开发组长希望代码注释尽可能细致；项目筹划人员希望代码设计文档尽可能详尽；测试、检查人员希望功能说明书尽可能细致等等。 假如这些文档都被要求写的话，保持它们同步比实行一个战役还痛苦。 为何不把这些信息保存在一个地点呢？？最明显想到的地点就是代码的注释中；但是你很难通览程序，并且有些须要这些文档的人并不懂编码。这篇文章将展示如何 通过运用 VS XML注释来处理这些疑问。代码注释、用户手册、开发人员手册、测试计划等很多文档可以很方便的从VS XML注释中取得。我将先演示如何 插入XML注释、如何 把这些XML注释导出为另一个文档。然后再讨论每个XML标记的意思，以及运用 XML和XSL生成帮助文件。所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释，编译器将忽略后面的内容。三条斜线告诉编译器，后面是VS XML注释，须要适当地处理。当开发人员输入三个向前的斜线后，Microsoft Visual Studio .NET IDE 自动检查它能不能在类或者类成员的解释的前面。假如是的话，Visual Studio .NET IDE 将自动插入注释标记，开发人员只须要添加些额外的标记和值。下面就是在成员函数前添加三个斜线，自动添加的注释。

xml文件的注释格式： <--被注释的内容 -- >，注释不能嵌套定义。

XML可以从HTML中分离数据。即能够在HTML文件之外将数据存储在XML文档中，这样可以使开发者集中精力使用HTML做好数据的显示和布局，并确保数据改动时不会导致HTML文件也需要改动，从而方便维护页面。XML也能够将数据以“数据岛”的形式存储在HTML页面中，开发者依然可以把精力集中到使用HTML格式化和显示数据上。

扩展资料：

XML可用于交换数据。基于XML可以在不兼容的系统之间交换数据，计算机系统和数据库系统所存储的数据有多种形式，对于开发者来说，最耗时间的工作就是在遍布网络的系统之间交换数据。把数据转换为XML格式存储将大大减少交换数据时的复杂性，还可以使这些数据能被不同的程序读取。

利用XML可以共享数据。XML数据以纯文本格式存储，这使得XML更易读、更便于记录、更便于调试，使不同系统、不同程序之间的数据共享变得更加简单。

参考资料来源：

百度百科-xml文件

---