C# 预处理器指令的用法

1，预处理器指令的概念

预处理器指令是指编译器在实际编译开始之前对信息进行预处理。通常用于简化源程序在不同的执行环境中的更改和编译。例如可以替换文本中的标记，将其他内容插入源文件，或者通过移除几个部分的文本来取消一部分文件的编译。不同于 C 和 C++ 中的指令，在 C# 中不能使用这些指令来创建宏，而且预处理器指令必须是一行中唯一的代码，不能掺杂其它。

示例如下：

(资料图)

#define condition       // 定义 condition 字符
using System;

public class ExampleProgram
{
    static void Main(string[] args)
    {
        #if (condition)         // 测试 condition 是否为真
            Console.WriteLine("condition is defined");
        #else
            Console.WriteLine("condition is not defined");
        #endif
            Console.ReadLine(); 
    }
}

2，预处理器指令的定义与使用

在 C# 程序中，所有的预处理器指令都是以标识符 # 开始，例如 #define 和 #if，并且预处理器指令之前只能出现空格不能出现任何代码。另外，预处理器指令不是语句，因此它们不需要以分号；结尾。

2.1，可为空上下文

#nullable 预处理器指令用于设置可为空注释上下文和为空警告上下文。#nullable 指令控制着是否可为空注释是否有效，以及是否给出为 Null 的警告。设置着每个上下文要么处于已禁用状态，要么处于已启用状态。

下表列出 #nullable 指令的用法：

用法	描述
#nullable disable	将可为空注释和警告上下文设置为“已禁用”。
#nullable enable	将可为空注释和警告上下文设置为“已启用”。
#nullable restore	将可为空注释和警告上下文还原为项目设置。
#nullable disable annotations	将可为空注释上下文设置为“已禁用”。
#nullable enable annotations	将可为空注释上下文设置为“已启用”。
#nullable restore annotations	将可为空注释上下文还原为项目设置。
#nullable disable warnings	将可为空警告上下文设置为“已禁用”。
#nullable enable warnings	将可为空警告上下文设置为“已启用”。
#nullable restore warnings	将可为空警告上下文还原为项目设置。

代码示例：

using System;

public class ExampleProgram
{
    static void Main(string[] args)
    {
        string? str;

    #nullable disable       // 将可为空注释和警告上下文设置为“已禁用”。 
        Console.WriteLine(str);         // 报错: 使用了未赋值的局部变量“str”

    #nullable enable        // 将可为空注释和警告上下文设置为“已启用”。 
        Console.WriteLine(str);
    }
}

代码界面：（PS：笔者使用的代码编辑器是 Visual Studio 2022）

2.2，定义符号

可以使用定义符号 #define 和取消定义符号 #undef 两个预处理器指令来定义或取消定义条件编译的符号。定义符号可用于 #if 等编译指令的条件，使用 #define 来定义符号，将符号用作传递给 #if 指令的表达式。

代码示例：

#define VERBOSE     // 定义符 #define
using System;

public class ExampleProgram
{
    static void Main(string[] args)
    {
        #if VERBOSE
                Console.WriteLine("详细输出版本");
        #endif
    }
}

代码执行结果：

详细输出版本

2.3，条件编译

可以使用以下四个预处理器指令来控制条件编译：

#if：打开条件编译，其中仅在定义了指定的符号时才会编译代码。#elif：关闭前面的条件编译，并基于是否定义了指定的符号打开一个新的条件编译。#else：关闭前面的条件编译，如果没有定义前面指定的符号，打开一个新的条件编译。#endif：关闭前面的条件编译。

代码示例：

#define condition2       // 定义 condition 字符
using System;

public class ExampleProgram
{
    static void Main(string[] args)
    {
        #if (condition)
            Console.WriteLine("condition is defined");
        #elif (condition2)      // 测试 condition2 是否为真 
            Console.WriteLine("condition2 is defined");
        #else
            Console.WriteLine("condition is not defined");
        #endif
            Console.ReadLine();
    }
}

代码执行结果：

csharp condition2 is defined

补充：

#if 以及 #else、#elif、#endif、#define 和 #undef 指令，允许在这些指令之间存在一个或多个符号里面包括或排除代码。其中，#if 指令开头的条件指令必须以 #endif 指令显式终止。可以使用#define 指令你定义一个符号，通过将该符号用作传递给 #if 指令的表达式。条件编译指令的用法和 C# 中的条件判断语句 if、elif 和 else 语句差不多。

2.4，定义区域

可以使用定义区域符号 #region 和 #endregion 分别表示启动区域和结束区域。这两个预处理器指令来定义可在大纲中折叠的代码区域。利用 #region 和 #endregion 指令，可以指定在使用代码编辑器的大纲功能时可展开或折叠的代码块。#region 指令后面可跟折叠区域的名称。在较长的代码文件中，折叠或隐藏一个或多个代码区域十分方便。

代码示例：

using System;

#region MyClass definition
public class ExampleProgram
{
    static void Main(string[] args)
    {
    }
}
#endregion

折叠前：

折叠后：

2.5，错误和警告信息

可以使用错误和警告信息指令告诉编译器生成用户定义的编译器错误和警告，并控制行信息。其中包括 #error、#warning 和 #line 指令。

#error：使用指定的消息生成编译器错误。

示例如下：

using System;

public class ExampleProgram
{
    static void Main(string[] args)
    {
        // 错误：此方法中的弃用代码。
        #error Deprecated code in this method.      
        Console.WriteLine("This is Deprecated code");
    }
}

代码界面：

#warning：使用指定的消息生成编译器警告。

示例如下：

using System;

public class ExampleProgram
{
    static void Main(string[] args)
    {
        // 警告：此方法中的弃用代码。
        #warning Deprecated code in this method.
        Console.WriteLine("This is Deprecated code");
    }
}

代码界面：

#line：更改用编译器消息输出的行号。

示例如下：

using System;

public class ExampleProgram
{
    static void Main()
    {
#line 200 "Special"
        int i;
        int j;
#line default       
        char c;
        float f;
#line hidden        // 编号不受影响
        string s;
        double d;
    }
}

编译产生以下输出：

Special(200,13): warning CS0168: The variable ‘i’ is declared but never used
Special(201,13): warning CS0168: The variable ‘j’ is declared but never used
MainClass.cs(9,14): warning CS0168: The variable ‘c’ is declared but never used
MainClass.cs(10,15): warning CS0168: The variable ‘f’ is declared but never used
MainClass.cs(12,16): warning CS0168: The variable ‘s’ is declared but never used
MainClass.cs(13,16): warning CS0168: The variable ‘d’ is declared but never used

#line 200 指令将下一行的行号强制设为 200（尽管默认值为 #6）；在执行下一个 #line 指令前，文件名都会报告为“特殊”。#line default 指令将行号恢复至默认行号，这会对上一指令重新编号的行进行计数。#line hidden 指令能对调试程序隐藏连续行，当开发者逐行执行代码时，介于 #line hidden 和下一 #line 指令（假设它不是其他 #line hidden 指令）间的任何行都将被跳过。

2.6，杂注

#pragma 为编译器给出特殊指令以编译它所在的文件，这些指令必须受编译器支持。换句话说，不能使用 #pragma 创建自定义的预处理指令。

#pragma 指令的语法可定义为： #pragma ，其中 pragma-name 为编译器支持 pragma 的名称，pragma-arguments 是特定于 pragma 的参数。例如 #pragma warning 表示启用或禁用警告，#pragma checksum 表示生成校验和。

代码示例：

using System;

#pragma warning disable 414, CS3021
[CLSCompliant(false)]
public class C
{
    int i = 1;
    static void Main()
    {
    }
}

#pragma warning restore CS3021
[CLSCompliant(false)]         
public class D
{
    int i = 1;
    public static void F()
    {
    }
}

代码界面：

3，预处理器指令的用途

预处理器指令的用途总结为以下几点：

有利于项目的调式和运行。例如说可以使用条件编译指令控制程序流的执行，在实际的项目中表现为多版本代码片段控制。在代码的调式阶段，可以使用错误和警告信息指令来禁止编译不属于本功能的额外代码。使用定义区域指令可以很好折叠和隐藏指定区域的代码片段。开发者可以更好的集中处理关键代码，在有着多个代码区域的项目十分的方便。