防止引用的程序集 PDB 和 XML 文件复制到输出

Question

我有一个 Visual Studio 2008 C#/.NET 3.5 项目，其中包含用于压缩内容的构建后任务。但是我发现我还在输出目录（和 ZIP）中获取引用的程序集的 .pdb（调试）和 .xml（文档）文件。

例如，如果 MyProject.csproj 引用 YourAssembly.dll，并且 DLL 所在的目录中有 YourAssembly.xml 和 YourAssembly.pdb 文件，它们将显示在我的输出目录（和 ZIP）中。

我可以在压缩时排除 *.pdb，但不能全面排除 *.xml 文件，因为我有具有相同扩展名的部署文件。

有没有办法阻止项目复制引用的程序集 PDB 和 XML 文件？

Answer 1

我希望能够在主应用程序中添加和删除引用的程序集，同时避免需要维护需要删除或排除的文件。

我仔细研究了 Microsoft.Common.targets 寻找可行的东西，并找到了 AllowedReferenceRelatedFileExtensions 属性。默认为 .pdb； .xml 所以我在项目文件中明确定义了它。问题是你需要一些东西（空格是不够的），否则它仍然会使用默认值。

<Project ...>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
    ...
    <AllowedReferenceRelatedFileExtensions>
      <!-- Prevent default XML and PDB files copied to output in RELEASE. 
           Only *.allowedextension files will be included, which doesn't exist in my case.
       -->
      .allowedextension
    </AllowedReferenceRelatedFileExtensions> 
  </PropertyGroup>

Answer 2

您还可以通过命令行指定：

MsBuild.exe build.file /p:AllowedReferenceRelatedFileExtensions=none

Answer 3

您可以添加类似于 del "$(TargetDir)YourAssembly*.xml", "$(TargetDir)YourAssembly*.pdb" 的构建后事件命令

Answer 4

前 2 个答案对我不起作用。我在此链接中找到了一个对我有用的解决方案。 http://kitsula.com/Article/How-to -从-msbuild中排除-xml-doc-files。

以防万一，上面的链接不起作用：

1. 在解决方案资源管理器中卸载项目

2. 右键单击该项目并单击“编辑 *.csproj”

3. 在每个环境的 PropertyGroup 部分中添加下一行。

4. 重新加载并重建项目。

    ;
             *.pdb；
             *.xml
    
   

Answer 5

这是一个相当老的问题，但由于没有关于如何通过 UI 关闭生成 PDB 和 XML 文件的答案，我认为为了完整性，它应该放在这里。

在 Visual Studio 2013 中：在项目属性中的“编译”选项卡下，取消选中“生成 XML 文档文件”，然后单击其下方的“高级编译选项”，并将“生成调试信息”更改为“无”，这样就可以解决问题。

Answer 6

我对其他答案没有太多运气，我终于弄清楚如何通过使用内置的 "删除"命令，显然您需要一种特定的方式实现通配符，它是有点微妙，这里是您需要放入“CSPROJ”中的所有内容 (TargetDir 是一个内置变量，自动包含在“Project”标签下：

<Target Name="RemoveFilesAfterBuild">   
    <ItemGroup>
        <XMLFilesToDelete Include="$(TargetDir)\*.xml"/>
        <PDBFilesToDelete Include="$(TargetDir)\*.pdb"/>
    </ItemGroup>
    <Delete Files="@(XMLFilesToDelete)" />
    <Delete Files="@(PDBFilesToDelete)" />
</Target>

我在生成各种语言特定文件夹时也遇到了问题，如果您也遇到这个问题，您也可以删除未使用的文件夹也有特定于语言的文件夹。我选择仅在构建类型“发布”下触发此操作：

<ItemGroup>
    <FluentValidationExcludedCultures Include="be;cs;cs-CZ;da;de;es;fa;fi;fr;ja;it;ko;mk;nl;pl;pt;ru;sv;tr;uk;zh-CN;zh-CHS;zh-CHT">
        <InProject>false</InProject>
    </FluentValidationExcludedCultures> 
</ItemGroup>

<Target Name="RemoveTranslationsAfterBuild" AfterTargets="AfterBuild" Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
    <RemoveDir Directories="@(FluentValidationExcludedCultures->'$(OutputPath)%(Filename)')" />

    <ItemGroup>
        <XMLFilesToDelete Include="$(TargetDir)\*.xml"/>
        <PDBFilesToDelete Include="$(TargetDir)\*.pdb"/>
    </ItemGroup>
    <Delete Files="@(XMLFilesToDelete)" />
    <Delete Files="@(PDBFilesToDelete)" />
</Target>

Answer 7

我的答案现在可能很简单，但我想分享我用来删除 xml 文件的 BAT 脚本（如果有相应的 dll）。如果您只想清理输出文件夹并且有其他不想删除的 xml 文件，那么它非常有用。

SETLOCAL EnableDelayedExpansion

SET targetDir=%1

ECHO Deleting unnecessary XML files for dlls

FOR %%F IN (%targetDir%*.xml) DO (

  SET xmlPath=%%~fF
  SET dllPath=!xmlPath:.xml=.dll!

  IF EXIST "!dllPath!" (
    ECHO Deleting "!xmlPath!"
    DEL "!xmlPath!"
  )
)

用法：

Cleanup.bat c:\my-output-folder\

我花了一个小时才完成这个简单的工作（感谢“延迟扩展”的东西），到处都是各种类型的搜索。希望对像我这样的其他BAT新手有帮助。

Answer 8

正如上面其他人建议的那样，使用 AllowedReferenceRelatedFileExtensions 属性对我来说无论是在项目文件中还是通过 msbuild 调用都效果很好。

但有一个警告，那就是它普遍有效。

如果我们有很多相互引用的项目，这也将删除属于顶部项目引用的底部项目的 pdb，而不仅仅是外部 pdb。

一种可能性是回退到基于项目的设置并将其仅添加到“底部”项目，但这仍然使得很难直接在顶部项目中摆脱中间外部引用，所以我不确定如何正确控制它。

在我看来，找到一种通用的方法来摆脱来自外部库的所有 pdb，但保留来自内部项目引用的所有 pdb

似乎对黄金分割有用的一件事是使用如下组合

/p:AllowedReferenceRelatedFileExtensions=.xml;.config /p:CopyLocalLockFileAssemblies=false 

： CopyLocalLockFileAssemblies 属性设置为 false 以防止从 NuGet 包复制 PDB 文件，并且 AllowedReferenceRelatedFileExtensions 属性设置为从外部 NuGet 包排除“.pdb”文件，但包括所有其他相关文件（“.xml”和“.config”文件）。包含 PDB 文件的本地引用项目在构建期间仍会将其 PDB 文件复制到输出目录

Answer 9

如果您只想排除 XML 文件（例如调试版本），您可以执行以下操作：

<AllowedReferenceRelatedFileExtensions>
  <!-- Prevent default XML from debug release  -->
      *.xml
 </AllowedReferenceRelatedFileExtensions>

基本上，列出的每个扩展名（以分号分隔）都将被排除。