《Effective C#》Item 4:使用Conditional属性来代替IF/ENDIF程序块

原创 2006年06月18日 11:26:00

在编码的时候,有时候需要添加一些DEBUG信息,来为了方便调试程序,但是到了真正发布的时候,又不希望把这些信息进行编译发布。那么在以前C或者C++编码的时候,用IF/ENDIF来定义程序块实现这个功能,而此方法在C#中可以继续沿用。

 

这种用IF/ENDIF来增加DEBUG信息块有两种方式,如下:

方式一,在一个函数中进行嵌入,例如:

#if DEBUG

            Trace.WriteLine( "ErrorMessage!" );

#endif

 

方式二,用IF/ENDIF填充整个函数,然后在需要加载的地方调用此函数即可,例如:

        private void DEBUG_TRACE( string strMsg )

        {

#if DEBUG

            Trace.WriteLine( strMsg );

#endif

        }

 

就这两种方式而言,都分别有些不足的地方。

对于方式一来说,首先增加过多的IF/ENDIF程序块,会使程序变得晦涩,而且代码太混乱。除此外,程序有可能出现潜在的BUG,考虑如下代码。

            string strMsg = null;

#if DEBUG

            strMsg = "Hello world!";

            Trace.WriteLine( strMsg );

#endif

            Console.WriteLine( strMsg );

这段代码,在DEBUG版本中一点儿问题都没有,但是在RELEASE版本中,由于会把IF/ENDIF这段程序块不会进行编译,那么就相当于如下:

            string strMsg = null;

            Console.WriteLine( strMsg );

很明显,如上这段代码是有问题的,而且这种问题也很难查出来。

 

而对于方式二来说,可以屏蔽方式一的缺陷,即至少程序看得不那么晦涩,而且会屏蔽方式一所存在的潜在BUG。但是它的实现方式是一个函数,虽说在RELEASE中,这个函数相当于一个空函数,什么都不干,不过在程序执行的时候,会在这个函数的调用以及返回损失一些效率。

 

在如上的两种方式中,我更喜欢后者,也就是说我宁可丧失一些效率,而不愿降低代码可读性。不过在C#中,有一种更好的方式来实现IF/ENDIF的功能,就是在函数上增加Conditional属性,从而达到和方式二一样的效果,例如:

    [Conditional( "DEBUG" )]

    private void DEBUG_TRACE( string strMsg )

    {

        Console.WriteLine( strMsg );

    }

 

很显然这种写法,非常清晰,代码简洁,且容易阅读。而且这种写法和方式二一样,也可以屏蔽潜在的BUG。对于效率来说,它的效率和方式一一样,我用如下的调用代码来说明。

    DEBUG_TRACE( "ERROR MESSAGE1" );

    Console.WriteLine( "Hello world!" );

    DEBUG_TRACE( "ERROR MESSAGE2" );

 

对于这段代码在RELEASE中生成的IL代码和如下的代码一样。

    Console.WriteLine( "Hello world!" );

 

根据如上的阐述,可以很轻松获得如下的一个对比表。

 

IF/ENDIF程序块

Conditional属性

第一种方式

第二种方式

代码可读性

差,晦涩

较好

最好

效率

其他

存在潜在BUG

不存在潜在BUG

不存在潜在BUG

 

不过使用Conditional属性的函数有个限制,就是不能有返回值,即必须以void来定义返回值。

 

而且用Conditional来增加多个属性,例如:

    [Conditional( "DEBUG" ),Conditional( "TRACE" )]

    private void DEBUG_TRACE( string strMsg )

    {

        Console.WriteLine( strMsg );

    }

 

不过这两个属性之间的关系是或的关系,即“DEBUG”或者“TRACE”任意一个被定义了,那么这段代码就会被执行。如果需要增加两个并的属性,直接用Conditional是无法实现的,需要借助IF/ENDIF来完成,如下:

    #if( DEBUG && TRACE )

    #define BOTH

#endif

    [Conditional( "BOTH" )]

    private void DEBUG_TRACE( string strMsg )

    {

        Console.WriteLine( strMsg );

    }

 

方法已经说到这里,可以基本上说完了。接下来,就说说如何设置环境变量,在C#中有三种设置方法。

方法一,直接在程序中加入,需要在一个文件的开头进行定义;

方法二,在项目中的编译命令行中进行设置;

方法三,是在操作系统中增加环境变量。

 

这三种方法,最常用的是前两种,具体如何设置,我这里不做细讲,参看MSDN即可完成

相关文章推荐

[Effective Java Distilled] Item 3 通过使用私有构造方法或者枚举类型来强化单例属性

关于Effective Java Distilled: 《Effective Java》这本书我断断续续的读了近两遍,里面的内容挺有深度,对提高工程代码质量也非常有帮助。我打算慢慢的整理出来一个...

《Effective C#》Item 11:提倡使用foreach语句来进行循环操作

循环语句是编程的基本语句,在C#中除了沿用C语言的循环语句外,还提供了foreach语句来实现循环。那么我要说的就是,在循环操作中尽量使用foreach语句来实现。   为了来更好地说明为什么要提...

C# #if, #else和#endif预处理指令

http://www.cnblogs.com/Peter-Luo/archive/2012/04/06/2434803.html #if 使您可以开始条件指令,测试一个或多个符号以查看它们是...
  • plean
  • plean
  • 2012年04月27日 14:19
  • 1077

【C#】利用Conditional属性完成编译忽略

Conditional是.NET提供关于编译的属性描述,其作用是添加到方法或属上,通过定义编译符的方式告指示编译器应忽略方法调用或属性在我们的代码中经常会出现Console.WriteLint(“XX...

#if, #elif, #else, #endif 使用

分类: C/C++   有些程序在调试、兼容性、平台移植等情况下可能想要通过简单地设置一些参数就生成一个不同的软件,这当然可以通过变量设置,把所有可能用到的代码都写进去,在初始化时配...
  • gqb666
  • gqb666
  • 2013年09月05日 10:12
  • 2832

80386(win32汇编) .if .else .endif 伪指令的使用

; 80386(win32)汇编 ;.if .else .endif的使用 ;作者:邱于涵 ;Time:2017年6月30日16:46:53 ;QQ:1031893464 .386 .model fl...

Effective C# 原则1:尽可能的使用属性(property),而不是数据成员(field)

http://www.cnblogs.com/WuCountry/archive/2007/02/10/646756.html Effective C# 原则1:尽可能的使用属性(property),...

hive中使用case、if:一个region统计业务(hive条件函数case、if、COALESCE语法介绍:CONDITIONAL FUNCTIONS IN HIVE)

前言:Hive ql自己设计总结1,遇到复杂的查询情况,就分步处理。将一个复杂的逻辑,分成几个简单子步骤处理。 2,但能合在一起的,尽量和在一起的。比如同级别的多个concat函数合并一个select...

【Effective Java】Ch2_创建销毁对象:Item3_通过私有构造函数或枚举类型来强化Singleton属性

所谓Singleton,是指仅能被实例化一次的类。Singleton通常代表本质上唯一的系统组件,例如窗口管理器或文件系统。让一个类成为Singleton就无法为Singleton替换模拟实现,除非它...

#if,#endif,!defined的意义和用法

  • 2012年05月10日 12:00
  • 20KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:《Effective C#》Item 4:使用Conditional属性来代替IF/ENDIF程序块
举报原因:
原因补充:

(最多只允许输入30个字)