C# 预处理器指令

预处理器指令 用于指示编译器如何对待处理源代码。

通用规则

预处理器指令的某些最重要的句法规则如下：

• 预处理器指令与 C# 代码必须分处不同的行。
• 预处理指定不通过分号终止。
• 每一行的预处理器指令以 # 字符开始。
  • # 字符前可以有空白。
  • # 字符和指令之间可以有空白。
• 允许 end-of-line 注释 //。
• 不允许使用 delimited 注释 /* ... */。

#define 和 undef 指令

一种编译符号（compilation symbol），并且仅有两种状态，已定义（defined）或未定义（undefined），它具有以下的特征：

• 标识符可以为任意值，但 true 和 false 除外。
• 它没有值。

#define 指令用于声明一个编译符号，#undef 指令用于取消一个编译符号的定义。

#define PremiumVersion
#define EconomyVersion
...
#undef PremiumVersion

#define 和 #undef 指令只能在源文件顶部使用，也就是 C# 代码之前。编译符号的作用于仅限于一个单一的源文件中。

条件编译指令

条件编译指令可以允许您根据某些特定的编译符号来决定哪些代码块需要编译以及哪些需要跳过。条件编译指令有四种：

• #if
• #else
• #elif
• #endif

指令后面的条件也就是返回 true 或者 false 的简单表达式。

• 条件可以是由一个编译符号或一个编译符号和运算符组成的表达式。子表达式可以使用圆括号进行分组。
• true 和 false 字面量同样可以用于条件表达式。

参数类型	含义	值
编译符号	使用 #define 定义的标识符	True：如果这个符号已使用 #define 定义 False：与上相反
表达式	编译符号和 !, ==, !=, &&, || 组成	True：表达式的值为 true False：与上相反

诊断指令

诊断指令用于生成用户自定义的编译时警告和错误消息。下面的就是诊断指令的句法，其中 Message 是字符串，但是需要注意的是，它和 C# 中的字符串不一样，它不需要使用引号括起来。

#warning Message
#error Message

当编译器遇到一个诊断指令的时候，它就会将与指令关联的消息输出。诊断指令消息将与编译器生成的任何警告和错误消息一同列出。

举个例子，下面的代码展示了 #error 和 #warning 指令的使用。

• #if 结构中有一个 #error 指令，如果 #if 指令的条件满足，那么 #error 指令中的消息将会生成。
• #warning 指令用于提醒程序员后期记得清理某个部分的代码。

#define RightHanded
#define LeftHanded

#if RightHanded && LeftHanded
#error Can't build for both RightHanded and LeftHanded
#endif

#warning Remember to come back and clean up this code!

行号指令

行号指令可以做以下几件事：

• 变更编译器警告和错误消息的显式行号。
• 变更被编译的源文件的显式文件名。
• 从交互式调试器中隐藏一序列行。

#line 指令的句法如下：

#line integer           // 将下一行行号设置为指定的整形值
#line "filename"        // 设置显式的文件名，双引号是必须的
#line default           // 恢复真实的行号和文件名

#line hidden            // 在分步调试器中隐藏下面的代码
#line                   // 在调试器中停止隐藏

#line 226
    x = y + z; // 编译器现在所认为的行号为 226
    ...

#line 330 "SourceFile.cs" // 变更报告的行号和文件名
    var1 = var2 + var3;

#line default // 恢复行号和文件名

区域指令

#region 可以允许您在一段代码上标注可选的名称，它由 #region 和 endregion 指令组成，特性如下：

• #region 指令放置在您想要标准的代码区域上部，#endregion 放置在代码区域的最后一行。
• #region 只能可以接受可选的文本字符串，可将其作为区域的名称。
• 区域当中可以嵌套区域。
  • 区域嵌套的层级不限。
  • #endregion 指令永远都是匹配它上面的第一个未匹配到的 #region 指令。

虽然编译器是直接忽略区域指令的，但是，它可以供源码工具，比如 Visual Studio 使用，用于隐藏或展示某个代码片段。

#pragma warning 指令

#pragma warning 指令允许您关闭或开启警告消息。

• 想要关闭警告消息，使用 disable 并在后面加上逗号隔开的警告数字列表。
• 想要恢复警告消息，使用 restore 并在后面加上逗号隔开的警告数字列表。

举个例子，下面的代码关闭了两个警告消息：618 和 414。后面，又开启了 618，但是 414 仍处于关闭状态：

#pragma warning disable 618, 414
...
#pragma warning restore 618

如果没有使用任何警告数字列表，那么这个命令将应用在所有的警告之上。举个例子，下面的代码关闭了所有的警告，并在后面又恢复了所有的警告：

#pragma warning disable
...
#pragma warning restore

参考资料

• Illustrated C# 2012, 4th Edtion