《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即可完成

使用Conditional属性来代替IF/ENDIF程序块

在编码的时候,有时候需要添加一些DEBUG信息,来为了方便调试程序,但是到了真正发布的时候,又不希望把这些信息进行编译发布。那么在以前C或者C++编码的时候,用IF/ENDIF来定义程序块实现这个功能...
  • courageously
  • courageously
  • 2010年07月12日 16:17
  • 316

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

在编码的时候,有时候需要添加一些DEBUG信息,来为了方便调试程序,但是到了真正发布的时候,又不希望把这些信息进行编译发布。那么在以前C或者C++编码的时候,用IF/ENDIF来定义程序块实现这个功能...
  • yangyangcong
  • yangyangcong
  • 2008年06月25日 19:58
  • 106

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

转:http://dev.csdn.net/author/Knight94/e5631391c7e54aff8cdd5e921dec8966.html《Effective C#》Item 4:使用Co...
  • flyskylf
  • flyskylf
  • 2007年09月30日 10:33
  • 350

使用Conditional特性代替#if条件编译

1原因 #if/#else条件编译常用来由同一份源代码生成不同的结果文件,最常见的有 debug版和release版。但是这些工具在具体的应用中并不是非常得心应手,因为它们它容易被滥用了,使用它们创...
  • zaiguo
  • zaiguo
  • 2011年11月14日 05:06
  • 472

#if....#endif的用法(C# 参考)

如果 C# 编译器遇到最后面跟有 #endif 指令的#if 指令,则仅当指定的符号已定义时,它才会编译这两个指令之间的代码。 例:   --在最顶端必须声明自定义的名称DEBUG或者STA...
  • wanlong360599336
  • wanlong360599336
  • 2012年09月18日 17:41
  • 4254

C# #if #else #endif 的使用

如果 C# 编译器遇到最后面跟有 #endif 指令的 #if 指令,则仅当指定的符号已定义时,它才会编译这两个指令之间的代码。不能对符号赋予数值;C# 中的 #if 语句是 Boolean,结合使...
  • CHEN504390172
  • CHEN504390172
  • 2013年12月10日 09:52
  • 2626

C#中 #if #endif的使用

#if #endif其实是C#预处理器指令中的两个。 预处理指令还包括以下这么多个,有兴趣的可以直接到C#指南查看 那么#if #endif如何使用呢? 先看定义“如果 C# 编译器遇到 #i...
  • t55p318
  • t55p318
  • 2017年08月26日 15:36
  • 541

c# Conditional用法详解

百度了一下关于conditional的文章,大都说的都是非常浅显,只是老生常谈了下尽量多使用conditional而少用#if,收获不大。 现在我自己测试了一下,也查阅了MSDN,有点心得,说出来与大...
  • fdyshlk
  • fdyshlk
  • 2017年08月26日 16:43
  • 679

过程及程序块的技巧

--代码2.1 使用书序结构计算员工薪资    DECLARE    v_sal1   NUMBER;    v_sal2   NUMBER;    v_sumsal NUMBER;  BEGIN  ...
  • G15738290530
  • G15738290530
  • 2016年07月13日 15:49
  • 273

C#的#if false #else #endif

#if FLAG xxx;        //自己的命令1 #else yyy;      //自己的命令2 #endif 可以像理解普通代码中的if……else一样理解。只不过该if……else...
  • ice_baili
  • ice_baili
  • 2014年03月04日 13:20
  • 1537
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:《Effective C#》Item 4:使用Conditional属性来代替IF/ENDIF程序块
举报原因:
原因补充:

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