是否需要在类库中部署 XML 文件? [英] Is it necessary to deploy the XML file in a class library?

问题描述

我在 VS 2012 中开发了很多类库项目，用于 Windows 窗体和 Web 窗体应用程序.

I have developed a lot of class library projects in VS 2012 to be used in Windows Forms and Web forms applications.

问题很简单.是否需要将 DLL 文件本身与创建的 XML 文件一起部署?

The question is simple. Do I need to deploy the DLL file itself together with the XML file that is created?

例如，类库项目称为DataWare.构建后，我在 Release 文件夹中得到了 5 个文件(该项目参考实体框架):

For example, the class library project is called DataWare. Upon building, I got 5 files in Release folder (this project reference Entity Framework):

• DataWare.dll
• DataWare.pdb
• DataWare.dll.config
• EntityFramework.dll
• EntityFramework.xml

我知道.pdb"文件包含调试信息，所以不需要部署.不考虑.config"文件.相反， App.config 或 Web.config 是.

I know that ".pdb" file contains debugging information, so there is no need to deploy. The ".config" file is not taken into account. Instead the App.config or Web.config are.

关于这个，我想我只需要部署 DataWare.dll 和 EntityFramework.dll.

Regarding this, I think I have to deploy just DataWare.dll and EntityFramework.dll.

然而，主要的疑问是我是否还需要部署 EntityFramework.xml.

However, the main doubt is if I need to deploy EntityFramework.xml as well.

问候詹姆

推荐答案

XML 文件包含公共类型的文档注释 &大会成员.

The XML file contains the doc comments for the public types & members in the assembly.

仅当您希望 Visual Studio 在 IntelliSense 中显示文档时才需要它.

You only need it if you want Visual Studio to show documentation in IntelliSense.

如果您要部署面向消费者的应用(而不是面向开发人员的可重用库)，则不需要它.

If you're deploying a consumer-facing app (as opposed to a developer-facing reusable library), you do not need it.

这篇关于是否需要在类库中部署 XML 文件?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！