c# - 如何设置条件编译变量？

Question

在 C/C++ 中，您可以在代码中定义宏，如下所示:

#define OLD_WAY  1

尽管我从未这样做过，但我认为 C# 中也有相同的功能。更重要的是，在 C/C++ 中，可以通过执行以下操作来执行一些条件编译逻辑:

#if OLD_WAY == 1
 int i = 0;
#else
 int i = 1;
#endif

好的，所以这一切都很酷。再一次，我假设这样的逻辑在 C# 中是可能的。我想知道的是，如何在项目级别定义常量，以便我可以放入逻辑，如果我以一种方式定义常量或另一块代码，则允许我有条件地编译一个代码块如果我不这样定义？我假设它是在项目属性的某个地方完成的，但是我如何以及在哪里定义它？

Answer 1

C# 编译器 csc.exe并且 C# 语言本身不会为 conditional compilation 公开任何预定义的常量。 . Visual Studio 只添加了 DEBUG和 TRACE值，可以通过 IDE 进行配置。 IDE 还允许您添加自己的任意符号，但由于这些本质上是固定(不变)值，因此该功能的用途有限。

可以通过手动编辑您的 .csproj 来设置更强大的自定义选项。项目文件。您可以设置conditions这里到 selectively propagate基于 MSBuild 中可用的大量环境和配置信息，将条件编译符号转换为 C# (参见 here 和 here ，但原则上，不可能有完整的列表，因为不同的组件可以随意贡献元数据)。

让我们考虑一个工作示例。有条件编译很有用的一种情况是，如果您想编写适应构建过程中发现的任何工具的代码。通过这种方式，您可以利用最新的语言功能，同时仍然保留在使用旧工具的机器上编译的能力，正如预期的那样，这些工具会拒绝外来语法和/或关键字。对于 C# 7.0 的特殊情况在 Visual Studio 2017 中，我们可以修改 .csproj如下:

.csproj 文件(摘录):



您还可以识别每个较旧的 C# 编译器，并在此过程中优雅地降级。检测 也是如此.NET 框架 版本(经常在 StackOverflow 上请求[1]
[2]
[3]
[4] ) 和任何其他环境构建条件。这些都是留给读者的练习，但如果您想从上面复制/粘贴突出显示的行，这里是文本版本。作为对屏幕截图的更新，我在此处的条件表达式中添加了单引号(即使没有它们似乎一切都可以工作)

<DefineConstants Condition="'$(VisualStudioVersion)'=='15'">CSHARP7</DefineConstants>
<!-- ... -->
<DefineConstants>DEBUG;TRACE;$(DefineConstants)</DefineConstants>
<!-- ... -->
<DefineConstants>TRACE;$(DefineConstants)</DefineConstants>

无论如何，以这种方式你现在可以写 条件 C# 代码 使用 #if… #elif… #else… #endif .继续示例案例，下面的代码使用新的元组语法(仅在 C# 7 中可用)来交换数组元素。顺便说一句，元组版本不仅更加简洁和/或优雅；它还生成出色的 CIL 代码:

#if CSHARP7
    (rg[i], rg[j]) = (rg[j], rg[i]);  // Swap elements: tuple syntax
#else
    var t = rg[i];                    // Swap elements: clunky
    rg[i] = rg[j];
    rg[j] = t;
#endif

请注意 Visual Studio IDE 正确处理您的手册 .csproj各方面的定制。鉴于 .csproj我之前展示过，IDE 代码编辑器可以正确识别和评估条件编译，以达到 IntelliSense 的目的。 , refactoring ，“调暗”非事件代码块等。

我还提到了 MSBuild拥有海量资料，其中 $(VisualStudioVersion)只是一个例子。不幸的是，要找出哪些值可用以及它们在构建时可能具有哪些值并不容易。一个技巧是将 C++ 项目与 C# 项目一起临时放入 Visual Studio 解决方案(如果您还没有)。如果您右键单击 项目属性为此 .vcxproj然后查看(例如) C/C++ 上的“其他包含目录”页面，点击编辑时，最右侧会出现一个下拉菜单:



您将看到一个带有“宏”按钮的对话框，您可以单击该按钮以根据当前在 IDE 中选择的平台和配置获取所有可用 MSBuild 变量及其预期值的列表。不要忽视 well-known item metadata列表底部的字段(以 % 为前缀)。



您可以通过此屏幕截图中滚动条拇指的大小了解此处有多少内容。 (它们按字母顺序列出；我只是滚动到“P”部分的这一部分，因为它包含最少的个人信息。)但是，重要的是要注意，(可用的)变量及其值在构建过程中，因此您可能会在此列表中找到您的 .csproj 不可用的项目。在它被处理的时候。

在构建过程中和整个构建过程中找出哪些属性值可用的另一种方法是将 MSBuild 的“输出详细程度”设置为“详细”，然后重新构建。



构建完成后，检查 Visual Studio 中构建日志的顶部 输出窗口 ，您将看到可用属性名称及其初始值的列表。