C# 预处理器指令

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› Node.js›Node.js教程

原作者: [db:作者] 来自: [db:来源] 收藏邀请

介绍

预处理指令是由编译器解释的命令，并影响输出或生成过程中的行为. 使用术语“预处理指令”只是为了与 C 和 C++ 编程语言保持一致。在 C# 中没有单独的预处理步骤，不像C和C++中，你不可以使用这些指令创建宏。预处理指令总是占用源代码中的单独一行，并且总是以 # 字符和预处理指令名称开头。# 字符的前面以及 # 字符与指令名称之间可以出现空白符。

接下来我们看看有关以下 C# 预处理器指令的信息：

#IF

如果 C# 编译器遇到最后面跟有 #endif 指令的 #if 指令，则仅当指定的符号已定义时，它才会编译这两个指令之间的代码。
C# 中的 #if 语句是 Boolean，仅测试符号是否已定义。
运算符 &&（与）和 ||（或）可用来评估多个符号是否已定义。还可以用括号将符号和运算符分组。
结合使用 #if 与 #else、#elif、#endif、#define 和 #undef 指令，可以根据一个或多个符号是否存在来包含或排除代码。在编译调试版本的代码或针对特定配置进行编译时，这会很有用。
以 #if 指令开始的条件指令必须用 #endif 指令显式终止。

#Else

#else 允许您创建复合条件指令，因此，如果前面的 #if 或（可选）#elif 指令中的任何表达式都不为 true，则编译器将计算 #else 与后面的 #endif 之间的所有代码。

#Elif

#elif 使您得以创建复合条件指令。如果前面的 #if 和前面的任何 #elif（可选）指令表达式的计算结果都不是 true，则将计算 #elif 表达式。如果 #elif 表达式计算为 true，编译器将计算位于 #elif 和下一个条件指令之间的所有代码。
使用 #elif 更简单，因为每个 #if 都需要一个 #endif，而 #elif 即使在没有匹配的 #endif 时也可以使用。

#Endif

#endif 指定以 #if 指令开头的条件指令的结尾

#Define

#define 可让您定义符号。当您将符号用作传递给 #if 指令的表达式时，此表达式的计算结果为 true

注意：不能像在 C 和 C++ 中的通常做法一样，使用 #define 指令来声明常数值。最好是将 C# 中的常数定义为类或结构的静态成员。如果具有多个像这样的常数，可以考虑创建一个单独的“Constants”类来保存这些常数。

针对以上指令我们提供一段代码：

如上所示：由于DEBUG 和 MYTEST都定义了，所以，如下代码

#elif (DEBUG && MYTEST)
Console.WriteLine("DEBUG and MYTEST are defined");

高亮显示可用，其他行代码置灰。

运行结果：

#Undef
#undef 使您可以取消符号的定义，以便通过将该符号用作 #if 指令中的表达式，使表达式的计算结果为 false。

示例代码：

#define DEBUG
#undef DEBUG
using System;
class MyClass
{
    static void Main()
    {
#if DEBUG
        Console.WriteLine("DEBUG is defined");
#else
        Console.WriteLine("DEBUG is not defined");
#endif
    }
}

运行结果：

#Warning
#warning 使您得以从代码的特定位置生成一级警告。例如：

#define DEBUG
class MainClass
{
    static void Main()
    {
#if DEBUG
#warning DEBUG is defined
#endif
    }
}

#Error

#error使您可以从代码中的特定位置生成错误。例如：

#define DEBUG
class MainClass
{
    static void Main()
    {
#if DEBUG
#error DEBUG is defined
#endif
    }
}

#Region

#region 是大家最为熟悉的指令，它使您可以在使用 Visual Studio 代码编辑器的大纲显示功能时指定可展开或折叠的代码块。在较长的代码文件中，能够折叠或隐藏一个或多个区域会十分便利，这样，您可将精力集中于当前处理的文件部分。下面的示例演示如何定义区域：

#region MyClass definition
public class MyClass
{
    static void Main()
    {
    }
}
#endregion

#region 块必须以 #endregion 指令终止。
#region 块不能与 #if 块重叠。但是，可以将 #region 块嵌套在 #if 块内，或将 #if 块嵌套在 #region 块内。

#endregion

#endregion 标记 #region 块的结尾

#line
#line 使您可以修改编译器的行号以及（可选）错误和警告的文件名输出。下面的示例说明如何报告与行号关联的两个警告。 #line 200 指令将行号强制设置为 200（尽管默认行号为 #7），在执行下一条 #line 指令之前，文件名将报告为“Special”。 #line default 指令将行号恢复为默认行号，默认行号对前一条指令重新编号的行进行计数。

输出结果：

备注
#line 指令可能由生成过程中的自动中间步骤使用。例如，如果行从原始的源代码文件中移除，但是您仍希望编译器基于文件中的原始行号生成输出，则可以移除行，然后用 #line 模拟原始行号。
#line hidden 指令对调试器隐藏若干连续的行，这样当开发人员在逐句通过代码时，将会跳过 #line hidden 和下一个 #line 指令（假定它不是另一个 #line hidden 指令）之间的所有行。此选项也可用来使 ASP.NET 能够区分用户定义的代码和计算机生成的代码。尽管 ASP.NET 是此功能的主要使用者，但很可能将有更多的源生成器使用它。
#line hidden 指令不会影响错误报告中的文件名或行号。即，如果在隐藏块中遇到错误，编译器将报告当前文件名和错误的行号。
#line filename 指令指定您希望出现在编译器输出中的文件名。默认情况下，使用源代码文件的实际名称。文件名必须用双引号 ("") 引起来且前面必须带一个行号。
源代码文件可以具有 #line 指令的任何编号。

示例 1
下面的示例说明调试器如何忽略代码中的隐藏行。运行此示例时，它将显示三行文本。但是，当设置如示例所示的断点并按 F10 键逐句通过代码时，您将看到调试器忽略了隐藏行。还请注意，即使在隐藏行上设置断点，调试器仍会忽略它。

#pragma

#pragma 为编译器提供特殊的指令，以说明如何编译包含杂注的文件。这些指令必须是编译器支持的指令。也就是说，不能使用 #pragma 创建自定义预处理指令。Microsoft C# 编译器支持以下两个 #pragma 指令：
#pragma warning
#pragma checksum

在日常开发的过程中我们总是会经常对代码进行编译,而在编译的过程中会出现许多信息,许多无用的警告信息总是会在编译过程中提示出来，以干扰一些主要的警告，对此也是可以通过预处理器指令来进行关闭来阻止其显示。

#pragma warning 可启用或禁用某些警告。

在创建的项目中，打开“输出”窗口（这样可以查看输出的警告编号：如(CS0414)）：Debug->Windows->Output,如下图所示：

然后我们做个测试：

using System;
class MainClass
{
    static void Main()
    {
        int i = 5;
        Console.ReadLine();
    }
}

public class test
{
    int i = 10;
}

对于如上代码，经过编译后出现如下类似警告：“变量i被分配，但从来没有使用过它的值”。

如果我们不想显示这些警告，可通过：#pragma warning disable 警告编号1, 警告编号2，来消除。
如上图所示，警告编号分别为CS0219，CS0414
注意：消除的编号不带”CS”，如下代码：

#pragma warning disable 0219,0414
using System;
class MainClass
{
    static void Main()
    {
        int i = 5;
        Console.ReadLine();
    }
}

public class test
{
    int i = 10;
}

编译项目查看输出结果：

没有警告了。

如果我们又想显示CS0414怎么办呢？
可以使用#pragma warning restore 警告编号1
如下代码：

#pragma warning disable 0219,0414
using System;
class MainClass
{
    static void Main()
    {
        int i = 5;
        Console.ReadLine();
    }
}
#pragma warning restore 0414
public class test
{
    int i = 10;
}