C# 预处理器指令
预处理器指令(Preprocessor Directives)指导编译器在实际编译开始之前对信息进行预处理。
通过这些指令,可以控制编译器如何编译文件或编译哪些部分。常见的预处理器指令包括条件编译、宏定义等。
所有的预处理器指令都是以 # 开始,且在一行上,只有空白字符可以出现在预处理器指令之前。
预处理器指令不是语句,所以它们不以分号 ; 结束。
C# 编译器没有一个单独的预处理器,但是,指令被处理时就像是有一个单独的预处理器一样。在 C# 中,预处理器指令用于在条件编译中起作用。与 C 和 C++ 不同的是,它们不是用来创建宏。一个预处理器指令必须是该行上的唯一指令。
C# 预处理器指令列表
下表列出了 C# 中可用的预处理器指令:
指令 | 描述 |
---|---|
#define | 定义一个符号,可以用于条件编译。 |
#undef | 取消定义一个符号。 |
#if | 开始一个条件编译块,如果符号被定义则包含代码块。 |
#elif | 如果前面的 #if 或 #elif 条件不满足,且当前条件满足,则包含代码块。 |
#else | 如果前面的 #if 或 #elif 条件不满足,则包含代码块。 |
#endif | 结束一个条件编译块。 |
#warning | 生成编译器警告信息。 |
#error | 生成编译器错误信息。 |
#region | 标记一段代码区域,可以在IDE中折叠和展开这段代码,便于代码的组织和阅读。 |
#endregion | 结束一个代码区域。 |
#line | 更改编译器输出中的行号和文件名,可以用于调试或生成工具的代码。 |
#pragma | 用于给编译器发送特殊指令,例如禁用或恢复特定的警告。 |
#nullable | 控制可空性上下文和注释,允许启用或禁用对可空引用类型的编译器检查。 |
实例
#if DEBUG
Console.WriteLine("Debug mode");
#elif RELEASE
Console.WriteLine("Release mode");
#else
Console.WriteLine("Other mode");
#endif
#warning This is a warning message
#error This is an error message
#region MyRegion
// Your code here
#endregion
#line 100 "MyFile.cs"
// The next line will be reported as line 100 in MyFile.cs
Console.WriteLine("This is line 100");
#line default
// Line numbering returns to normal
#pragma warning disable 414
private int unusedVariable;
#pragma warning restore 414
#nullable enable
string? nullableString = null;
#nullable disable
#define 和 #undef 预处理器
#define 用于定义符号(通常用于条件编译),#undef 用于取消定义符号。
#define DEBUG #undef RELEASE
#define 允许您定义一个符号,这样,通过使用符号作为传递给 #if 指令的表达式,表达式将返回 true。它的语法如下:
#define symbol
下面的程序说明了这点:
实例
using System;
namespace PreprocessorDAppl
{
class Program
{
static void Main(string[] args)
{
#if (PI)
Console.WriteLine("PI is defined");
#else
Console.WriteLine("PI is not defined");
#endif
Console.ReadKey();
}
}
}
当上面的代码被编译和执行时,它会产生下列结果:
PI is defined
条件指令:#if, #elif, #else 和 #endif
您可以使用 #if 指令来创建一个条件指令。
条件指令用于测试符号是否为真。如果为真,编译器会执行 #if 和下一个指令之间的代码。
条件指令的语法:
#if symbol [operator symbol]...
其中,symbol 是要测试的符号名称。您也可以使用 true 和 false,或在符号前放置否定运算符。
常见运算符有:
- == (等于)
- != (不等于)
- && (与)
- || (或)
您也可以用括号把符号和运算符进行分组。条件指令用于在调试版本或编译指定配置时编译代码。一个以 #if 指令开始的条件指令,必须显示地以一个 #endif 指令终止。
#define DEBUG #if DEBUG Console.WriteLine("Debug mode"); #elif RELEASE Console.WriteLine("Release mode"); #else Console.WriteLine("Other mode"); #endif
下面的程序演示了条件指令的用法:
实例
#define VC_V10
using System;
public class TestClass
{
public static void Main()
{
#if (DEBUG && !VC_V10)
Console.WriteLine("DEBUG is defined");
#elif (!DEBUG && VC_V10)
Console.WriteLine("VC_V10 is defined");
#elif (DEBUG && VC_V10)
Console.WriteLine("DEBUG and VC_V10 are defined");
#else
Console.WriteLine("DEBUG and VC_V10 are not defined");
#endif
Console.ReadKey();
}
}
当上面的代码被编译和执行时,它会产生下列结果:
DEBUG and VC_V10 are defined
#warning 和 #error
#warning 用于生成编译器警告,#error 用于生成编译器错误。
#warning This is a warning message #error This is an error message
#region 和 #endregion
用于代码折叠,使代码更加可读。
#region MyRegion // Your code here #endregion
#line
用于更改文件行号和文件名的编译器输出。
#line 100 "MyFile.cs" // The next line will be reported as line 100 in MyFile.cs Console.WriteLine("This is line 100"); #line default // Line numbering returns to normal
#pragma
用于向编译器发送特殊指令。最常见的用法是禁用特定的警告。
#pragma warning disable 414 private int unusedVariable; #pragma warning restore 414
使用预处理器指令的注意事项
- 提高代码可读性:使用
#region
可以帮助分隔代码块,提高代码的组织性。 - 条件编译:通过
#if
等指令可以在开发和生产环境中编译不同的代码,方便调试和发布。 - 警告和错误:通过
#warning
和#error
可以在编译时提示开发人员注意特定问题。
通过正确使用这些预处理器指令,可以更好地控制代码的编译过程,提高代码的灵活性和可维护性。
樱花树
100***2797@qq.com
预处理器指令的用途理解:
在程序调试和运行上有重要的作用。比如预处理器指令可以禁止编译器编译代码的某一部分,如果计划发布两个版本的代码,即基本版本和有更多功能的企业版本,就可以使用这些预处理器指令来控制。在编译软件的基本版本时,使用预处理器指令还可以禁止编译器编译于额外功能相关的代码。另外,在编写提供调试信息的代码时,也可以使用预处理器指令进行控制。总的来说和普通的控制语句(if等)功能类似,方便在于预处理器指令包含的未执行部分是不需要编译的。
其他预处理器指令:
#warning 和 #error:
当编译器遇到它们时,会分别产生警告或错误。如果编译器遇到 #warning 指令,会给用户显示 #warning 指令后面的文本,之后编译继续进行。如果编译器遇到 #error 指令,就会给用户显示后面的文本,作为一条编译错误消息,然后会立即退出编译。使用这两条指令可以检查 #define 语句是不是做错了什么事,使用 #warning 语句可以提醒自己执行某个操作。
2. #region 和 #endregion
#region 和 #endregion 指令用于把一段代码标记为有给定名称的一个块,如下所示:
这看起来似乎没有什么用,它不影响编译过程。这些指令的优点是它们可以被某些编辑器识别,包括 Visual Studio .NET 编辑器。这些编辑器可以使用这些指令使代码在屏幕上更好地布局。
3. #line
#line 指令可以用于改变编译器在警告和错误信息中显示的文件名和行号信息,不常用。
如果编写代码时,在把代码发送给编译器前,要使用某些软件包改变输入的代码,就可以使用这个指令,因为这意味着编译器报告的行号或文件名与文件中的行号或编辑的文件名不匹配。#line指令可以用于还原这种匹配。也可以使用语法#line default把行号还原为默认的行号:
4. #pragma
#pragma 指令可以抑制或还原指定的编译警告。与命令行选项不同,#pragma 指令可以在类或方法级别执行,对抑制警告的内容和抑制的时间进行更精细的控制。如下:
樱花树
100***2797@qq.com