C# 预处理器指令

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

通用规则

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

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

#defineundef 指令

一种编译符号(compilation symbol),并且仅有两种状态,已定义(defined)或未定义(undefined),它具有以下的特征:

  • 标识符可以为任意值,但 truefalse 除外。
  • 它没有值。

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

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

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

条件编译指令

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

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

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

  • 条件可以是由一个编译符号或一个编译符号和运算符组成的表达式。子表达式可以使用圆括号进行分组。
  • truefalse 字面量同样可以用于条件表达式。
参数类型 含义
编译符号 使用 #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 可以允许您在一段代码上标注可选的名称,它由 #regionendregion 指令组成,特性如下:

  • #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

参考资料

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,864评论 6 494
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,175评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,401评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,170评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,276评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,364评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,401评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,179评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,604评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,902评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,070评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,751评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,380评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,077评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,312评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,924评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,957评论 2 351

推荐阅读更多精彩内容