.NET 程序集文件附带的 XML 文件是什么？答案

【问题标题】：What's the XML file that comes together with a .NET assembly file?.NET 程序集文件附带的 XML 文件是什么？
【发布时间】：2012-05-20 19:35:21
【问题描述】：

许多 .NET 程序集都附带一个 XML 文件。例如，System.Web.WebPages.Razor.dll 与包含以下内容的 System.Web.WebPages.Razor.xml 一起出现：

<?xml version="1.0" encoding="utf-8" ?> 
<doc>
   <assembly>
       <name>System.Web.WebPages.Razor</name> 
   </assembly>
   <members>
       <member name="T:System.Web.WebPages.Razor.PreApplicationStartCode" /> 
       <member name="M:System.Web.WebPages.Razor.PreApplicationStartCode.Start" /> 
       <member name="T:System.Web.WebPages.Razor.RazorBuildProvider" /> 
       <member name="M:System.Web.WebPages.Razor.RazorBuildProvider.#ctor" />
        Much more elements follow...
   </members>
</doc>

这个 XML 有什么用？我在运行时需要它吗？

【问题讨论】：

标签： .net xml .net-assembly

【解决方案1】：

它是代码 cmets / IntelliSense 文件，由 IDE（即 Visual Studio）使用，而不是运行时 - 它是所有扩展方法/参数/类型描述等的来源。

您不需要将它与您的二进制文件一起部署，但它也没有害处。它在 IDE 中也是完全可选的 - 只是：如果没有它，IntelliSense 对您的信息将更少（它只会显示名称和类型等 - 而不是更详细的方法描述）。

在自己的库中，使用 /// 语法编写自己的代码 cmets，并在 project-properties 中启用 XML 文件生成。

【讨论】：

【解决方案2】：

这是该程序集的 XML 文档。这仅用于 VisualStudio 中的 Intellisense。详情请参考this answer。

【讨论】：