MSBuild 中的特殊字符($ @ % 等):含义、用法以及转义

在 MSBuild 中有一些特殊字符,如 $ @ % ' 等,本文介绍他们的含义,如何使用他们,以及你真的需要这些字符的时候如何编写他们。


特殊字符

MSBuild 中有这些特殊字符:

含义和用法

$

引用一个属性或者环境变量。

<Project>
  <ItemGroup>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <OutputPath>bin\$(Configuration)</OutputPath>
  </ItemGroup>
</Project>

比如以下两篇博客列出了一些最典型的使用场景。

@

引用一个集合。

<Target Name="WalterlvDemoTarget" BeforeTargets="CoreCompile">
    <Message Text="References:" />
    <Message Text="@(Reference)" />
</Target>

比如以下两篇博客列出了一些最典型的使用场景:

%

引用集合中某一个项的某个属性。

<Target Name="Xxx" AfterTargets="AfterBuild">
    <ItemGroup>
        <Walterlv Include="@(Compile)=%(Compile.CopyToOutputDirectory)" />
    </ItemGroup>
    <Warning Text="@(Walterlv)" />
</Target>

比如下面两篇博客列出了此字符的一些使用:

'

在形成一个字符串的时候,会使用到此字符。

下面这篇博客列出了此字符的一些使用:

;

如果存在分号,那么在形成一个集合的时候,会被识别为集合中的各个项之间的分隔符。

有时候你真的需要分号而不是作为分隔符的时候,需要进行转义:

?*

作为通配符使用。一个 * 表示文件或者文件夹通配符,而 ** 则表示任意层级的文件或文件夹。

下面这篇博客虽然古老,却也说明了其用法:

转义

在 MSBuild 中,由于这些特殊字符其实非常常见,所以与一些已有的值很容易冲突,所以需要转义。

转义可以使用 ASCII 编码:

转义方法一:

<Compile Include="Walterlv1%3BWalterlv2.cs"/>

这样得到的将是一个名字为 Walterlv1;Walterlv2.cs 的文件,而不是两个文件。

转义方法二:

<Compile Include="$([MSBuild]::Escape('Walterlv1;Walterlv2.cs'))" />

详细方法可参见:


参考资料

blog bulletin

本文会经常更新,请阅读原文: https://blog.walterlv.com/post/msbuild-special-characters.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

如果你想持续阅读我的最新博客,请点击 RSS 订阅,或者前往 CSDN 关注我的主页

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://blog.walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com)