掌握 C# 预处理器指令：条件编译、诊断控制与代码组织实战

C# 预处理器指令完全指南

深度解析 C# 预处理器指令：条件编译、符号定义、警告/错误控制、行号重写、代码分区与编译器指示，附实战示例与最佳实践。

预处理器指令是编译器在正式编译前处理的命令。它们控制哪些代码参与编译、如何处理警告错误、甚至修改编译器对行号/文件名的诊断视图。

C# 中指令以 # 开头，单行结束（无需分号）。

#if DEBUG
    // 调试代码
#endif

#if COND1
    ...
#elif COND2
    ...
#endif

#if COND
    ...
#else
    ...
#endif

#if COND ... #endif

#region 初始化
    ...
#endregion

定义与取消符号

• #define：创建符号，在 #if 中求值为 true。必须出现在文件首行（前面只能有注释）。
• #undef：移除符号，使其求值为 false。

示例

#define TESTING   // 定义符号
#undef TESTING    // 取消符号

条件编译：#if、#elif、#else、#endif

• #if 测试表达式；表达式为真时编译内部代码。
• 表达式支持逻辑运算符：&&（与）、||（或）、!（非）及符号组合。
• #elif 串联多个条件；#else 兜底；#endif 必须闭合。

实战示例

#define CSHARP
#undef PYTHON

using System;

namespace Directive {
    class ConditionalDirective {
        static void Main(string[] args) {
            #if (CSHARP && PYTHON)
                Console.WriteLine("CSHARP 和 PYTHON 均已定义");
            #elif (CSHARP && !PYTHON)
                Console.WriteLine("CSHARP 已定义，PYTHON 未定义");
            #elif (!CSHARP && PYTHON)
                Console.WriteLine("PYTHON 已定义，CSHARP 未定义");
            #else
                Console.WriteLine("CSHARP 和 PYTHON 均未定义");
            #endif
        }
    }
}

输出：CSHARP 已定义，PYTHON 未定义

生成警告与错误

• #warning：输出用户自定义警告，不阻止编译。
• #error：输出致命错误，立即终止编译。

警告示例

using System;

namespace Directives {
    class WarningDirective {
        public static void Main(string[] args) {
            #if (!CSHARP)
                #warning CSHARP 未定义
            #endif
            Console.WriteLine("#warning 指令示例");
        }
    }
}

编译输出包含警告行，但程序仍可运行，控制台打印文本。

错误示例

using System;

namespace Directive {
    class Error {
        public static void Main(string[] args) {
            #if (!CSHARP)
                #error CSHARP 未定义
            #endif
            Console.WriteLine("#error 指令示例");
        }
    }
}

编译失败，报错 CSHARP 未定义，最后一行永不执行。

自定义诊断位置：#line

• 修改后续代码的报告行号与文件名，常用于代码生成工具。

示例

using System;

namespace Directive {
    class LineDemo {
        public static void Main(string[] args) {
            #line 200 "AnotherProgram.cs"
            #warning Actual warning generated by Program.cs on line 10
        }
    }
}

结果：警告显示为 AnotherProgram.cs(200,22): warning CS1030: ...

代码区域组织：#region / #endregion

• 将相关代码分组，Visual Studio 等 IDE 可折叠/展开。
• 区域不能重叠，但可嵌套在条件编译块内。

示例

using System;

namespace Directive {
    class RegionDemo {
        public static void Main(string[] args) {
            #region Hello
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            Console.WriteLine("Hello");
            #endregion
        }
    }
}

输出：五行 "Hello"。

高级编译器控制：#pragma

• 细粒度控制编译器行为。
• 常用场景：
  • #pragma warning disable：禁用所有警告
  • #pragma warning restore：恢复警告
  • #pragma warning disable CS0168：仅禁用特定警告（如“变量已声明但未使用”）
  • #pragma checksum：生成校验和用于调试

示例

using System;

namespace Directive {
    class PragmaDemo {
        public static void Main(string[] args) {
            #pragma warning disable
            #warning 这是警告 1
            #pragma warning restore
            #warning 这是警告 2
        }
    }
}

仅显示第二个警告。

深入参考：#pragma (C# 参考)