一、C#預(yù)處理器指示符(詳細(xì)點(diǎn)擊連接到MSDN查看)
#if
#else
#elif
#endif
# define
#undef
#warning
#error
#line
#region
#endregion
#pragma
#pragma warning
#pragma checksum
二、詳細(xì)介紹
下面將對(duì)這些指令逐一介紹(轉(zhuǎn)錄自http://www.cnblogs.com/aivdesign/articles/1241775.html)
1. #define和#undef
#define可以定義符號(hào)。當(dāng)將符號(hào)用作傳遞給#if指令的表達(dá)式時(shí),此表達(dá)式的計(jì)算結(jié)果true。如
#define DEBUG
它告訴編譯器存在給定名稱的符號(hào),在本例中是DEBUG。這個(gè)符號(hào)不是實(shí)際代碼的一部分,只在編譯代碼時(shí)存在。
#undef正好相反,它刪除一個(gè)符號(hào)。
必須把#define和#undef命令放在C#源碼的開頭,即在要編譯的任何代碼之前。它不像C++中那樣可以定義常數(shù)值。
#define本身并無(wú)大用,它需要配合#if指令使用。
如
#define DEBUG
int DoSw(double x)
{
#if DEBUG
COnsole.WriteLine("x is"+X);
#edif
}
2. #if, #elif, #else和#endif
這些指令告訴編譯器是否要編譯某個(gè)代碼塊。看下面的方法:
static void PrintVersion()
{
#if V3
Console.WriteLine("Version 3.0");
#elif V2
Console.WriteLine("Version 2.0");
#else
Console.WriteLine("Version 1.0");
#endif
}
上面的代碼會(huì)根據(jù)定義的符號(hào)來(lái)打印不同的版本信息。 這種方式成為條件編譯。
注意:
使用#if不是條件編譯代碼的唯一方式,C#還提供了通過(guò)Conditional屬性的機(jī)制。
#if和#elif還支持一組邏輯運(yùn)算符!=,==,!=和|| 。如果符號(hào)存在,符號(hào)的值被認(rèn)為是true,否則為false,如:
#if V3 || (V2 == true) // if 定義了V3或V2符號(hào)...
3. #warning和#error
這也是兩個(gè)很有用的預(yù)處理器指令,編譯器遇到它們時(shí),會(huì)分別產(chǎn)生警告或錯(cuò)誤信息。如果遇到#warning指令,會(huì)向用戶顯示#warning指令后面的文本。實(shí)際上,在VS2005中,IDE會(huì)直接將信息標(biāo)識(shí)出來(lái):
而如果編譯器遇到#error,就會(huì)立即退出編譯,不會(huì)產(chǎn)生IL代碼。
使用這兩個(gè)指令可以檢查#define是不示做錯(cuò)了什么事,使用#warning可以讓自己想起做什么事。
#if DEBUG && RELEASE
#error "You 've define xxxx!"
#ednif
#warning "Don't forgot to removexxxxxx!"
Console.WriteLine("I have this job");
4. #region和#endregion
#region和#endregion指令用于把一段代碼標(biāo)記為有指定名稱的一個(gè)塊,如下所示:
#region private methods
private int x;
private int y;
#endregion
這兩個(gè)指令不會(huì)影響編譯過(guò)程。但可以為VS編輯器所識(shí)別,從而使得代碼顯示布局更為清晰。
5. #line
可以用于改變編譯器在警告和錯(cuò)誤信息中顯示的文件的名字和行號(hào)信息。如果編寫代碼時(shí),在把代碼發(fā)給比編譯器前,要使用某些軟件包改變鍵入的代碼,可以使用這個(gè)指令,因?yàn)檫@意味著比編譯器的報(bào)告的行號(hào)或文件名與文件中的行號(hào)或編譯的文件名不匹配。#line指令可以用于恢復(fù)這種匹配也可以使用語(yǔ)法#line default 把行號(hào)恢復(fù)默認(rèn)。
#line 164 "cORE.CS"
#LINE default
6. #pragma,#pragma warning,#pragma checksum
#pragma:為編譯器提供特殊的指令,說(shuō)明如何編譯包含雜注的文件。
#pragma warning:可啟用或禁用某些警告。
#pragma checksum:生成源文件的校驗(yàn)和,以幫助調(diào)試ASP.NET頁(yè)。
可以抑制或恢復(fù)指定的編譯警告。與命令行選項(xiàng)不同,#pragma指令可以在類和方法上執(zhí)行,對(duì)抑制什么警告和抑制的時(shí)間進(jìn)行更精細(xì)的控制。
#pragma warning disable 169
public class Aclass
{
int nFiled;
}
#pragma warning restore 169
三、更好的替代方案
利用條件屬性代替(轉(zhuǎn)錄自http://www.cnblogs.com/wucountry/archive/2007/02/13/649549.html)
使用#if/#endif 塊可以在同樣源碼上生成不同的編譯(結(jié)果),大多數(shù)debug和release兩個(gè)版本。但它們決不是我們喜歡用的工具。由于#if/#endif很容易被濫用,使得編寫的代碼難于理解且更難于調(diào)試。程序語(yǔ)言設(shè)計(jì)者有責(zé)任提供更好的工具,用于生成在不同運(yùn)行環(huán)境下的機(jī)器代碼。C#就提供了條件屬性(Conditional attribute)來(lái)識(shí)別哪些方法可以根據(jù)環(huán)境設(shè)置來(lái)判斷是否應(yīng)該被調(diào)用。
這個(gè)方法比條件編譯#if/#endif更加清晰明白。編譯器可以識(shí)別Conditional屬性,所以當(dāng)條件屬性被應(yīng)用時(shí),編譯器可以很出色的完成工作。條件屬性是在方法上使用的,所以這就使用你必須把不同條件下使用的代碼要寫到不同的方法里去。當(dāng)你要為不同的條件生成不同的代碼時(shí),請(qǐng)使用條件屬性而不是#if/#endif塊。
很多編程老手都在他們的項(xiàng)目里用條件編譯來(lái)檢測(cè)先決條件(per-conditions)和后續(xù)條件(post-conditions)。
(注:per-conditions,先決條件,是指必須滿足的條件,才能完成某項(xiàng)工作,而post-conditions,后續(xù)條件,是指完成某項(xiàng)工作后一定會(huì)達(dá)到的條件。例如某個(gè)函數(shù),把某個(gè)對(duì)象進(jìn)行轉(zhuǎn)化,它要求該對(duì)象不能為空,轉(zhuǎn)化后,該對(duì)象一定為整形,那么:per-conditions就是該對(duì)象不能為空,而post-conditions就是該對(duì)象為整形。例子不好,但可以理解這兩個(gè)概念。)
你可能會(huì)寫一個(gè)私有方法來(lái)檢測(cè)所有的類及持久對(duì)象。這個(gè)方法可能會(huì)是一個(gè)條件編譯塊,這樣可以使它只在debug時(shí)有效。
private void CheckState( )
{
// The Old way:
#if DEBUG
Trace.WriteLine( "Entering CheckState for Person" );
// Grab the name of the calling routine:
string methodName =
new StackTrace( ).GetFrame( 1 ).GetMethod( ).Name;
Debug.Assert( _lastName != null,
methodName,
"Last Name cannot be null" );
Debug.Assert( _lastName.Length > 0,
methodName,
"Last Name cannot be blank" );
Debug.Assert( _firstName != null,
methodName,
"First Name cannot be null" );
Debug.Assert( _firstName.Length > 0,
methodName,
"First Name cannot be blank" );
Trace.WriteLine( "Exiting CheckState for Person" );
#endif
}
使用#if和#endif編譯選項(xiàng)(pragmas),你已經(jīng)為你的發(fā)布版(release)編譯出了一個(gè)空方法。這個(gè)CheckState()方法會(huì)在所有的版本(debug和release)中調(diào)用。而在release中它什么也不做,但它要被調(diào)用。因此你還是得為例行公事的調(diào)用它而付出小部份代價(jià)。
不管怎樣,上面的實(shí)踐是可以正確工作的,但會(huì)導(dǎo)致一個(gè)只會(huì)出現(xiàn)在release中的細(xì)小BUG。下面的就是一個(gè)常見的錯(cuò)誤,它會(huì)告訴你用條件編譯時(shí)會(huì)發(fā)生什么:
public void Func( )
{
string msg = null;
#if DEBUG
msg = GetDiagnostics( );
#endif
Console.WriteLine( msg );
}
這一切在Debug模式下工作的很正常,但在release下卻輸出的為空行。release模式很樂(lè)意給你輸出一個(gè)空行,然而這并不是你所期望的。傻眼了吧,但編譯器幫不了你什么。你的條件編譯塊里的基礎(chǔ)代碼確實(shí)是這樣邏輯。一些零散的#if/#endif塊使你的代碼在不同的編譯條件下很難得診斷(diagnose)。
C#有更好的選擇:這就是條件屬性。用條件屬性,你可以在指定的編譯環(huán)境下廢棄一個(gè)類的部份函數(shù), 而這個(gè)環(huán)境可是某個(gè)變量是否被定義,或者是某個(gè)變量具有明確的值。這一功能最常見的用法就是使你的代碼具有調(diào)試時(shí)可用的聲明。.Net框架庫(kù)已經(jīng)為你提供了了基本泛型功能。這個(gè)例子告訴你如何使用.net框架庫(kù)里的兼容性的調(diào)試功能,也告訴你條件屬性是如何工作的以及你在何時(shí)應(yīng)該添加它:
當(dāng)你建立了一個(gè)Person的對(duì)象時(shí),你添加了一個(gè)方法來(lái)驗(yàn)證對(duì)象的不變數(shù)據(jù)(invariants):
private void CheckState( )
{
// Grab the name of the calling routine:
string methodName =
new StackTrace( ).GetFrame( 1 ).GetMethod( ).Name;
Trace.WriteLine( "Entering CheckState for Person:" );
Trace.Write( "\tcalled by " );
Trace.WriteLine( methodName );
Debug.Assert( _lastName != null,
methodName,
"Last Name cannot be null" );
Debug.Assert( _lastName.Length > 0,
methodName,
"Last Name cannot be blank" );
Debug.Assert( _firstName != null,
methodName,
"First Name cannot be null" );
Debug.Assert( _firstName.Length > 0,
methodName,
"First Name cannot be blank" );
Trace.WriteLine( "Exiting CheckState for Person" );
}
這這個(gè)方法上,你可能不必用到太多的庫(kù)函數(shù),讓我簡(jiǎn)化一下。這個(gè)StackTrace 類通過(guò)反射取得了調(diào)用方法的的名字。這樣的代價(jià)是昂貴的,但它確實(shí)很好的簡(jiǎn)化了工作,例如生成程序流程的信息。這里,斷定了CheckState所調(diào)用的方法的名字。被判定(determining)的方法是System.Diagnostics.Debug類的一部份,或者是System.Diagnostics.Trace類的一部份。Degbug.Assert方法用來(lái)測(cè)試條件是否滿足,并在條件為false時(shí)會(huì)終止應(yīng)用程序。剩下的參數(shù)定義了在斷言失敗后要打印的消息。Trace.WriteLine輸出診斷消息到調(diào)試控制臺(tái)。因此,這個(gè)方法會(huì)在Person對(duì)象不合法時(shí)輸出消息到調(diào)試控制臺(tái),并終止應(yīng)用程序。你可以把它做為一個(gè)先決條件或者后繼條件,在所有的公共方法或者屬性上調(diào)用這個(gè)方法。
public string LastName
{
get
{
CheckState( );
return _lastName;
}
set
{
CheckState( );
_lastName = value;
CheckState( );
}
}
在某人試圖給LastName賦空值或者null時(shí),CheckState會(huì)在第一時(shí)間引發(fā)一個(gè)斷言。然后你就可以修正你的屬性設(shè)置器,來(lái)為L(zhǎng)astName的參數(shù)做驗(yàn)證。這就是你想要的。
但這樣的額外檢測(cè)存在于每次的例行任務(wù)里。你希望只在調(diào)試版中才做額外的驗(yàn)證。這時(shí)候條件屬性就應(yīng)運(yùn)而生了:
[ Conditional( "DEBUG" ) ]
private void CheckState( )
{
// same code as above
}
Conditional屬性會(huì)告訴C#編譯器,這個(gè)方法只在編譯環(huán)境變量DEBUG有定義時(shí)才被調(diào)用。同時(shí),Conditional屬性不會(huì)影響CheckState()函數(shù)生成的代碼,只是修改對(duì)函數(shù)的調(diào)用。如果DEBGU標(biāo)記被定義,你可以得到這:
public string LastName
{
get
{
CheckState( );
return _lastName;
}
set
{
CheckState( );
_lastName = value;
CheckState( );
}
}
如果不是,你得到的就是這:
public string LastName
{
get
{
return _lastName;
}
set
{
_lastName = value;
}
}
不管環(huán)境變量的狀態(tài)如何,CheckState()的函數(shù)體是一樣的。這只是一個(gè)例子,它告訴你為什么要弄明白.Net里編譯和JIT之間的區(qū)別。不管DEBUG環(huán)境變量是否被定義,CheckState()方法總會(huì)被編譯且存在于程序集中。這或許看上去是低效的,但這只是占用一點(diǎn)硬盤空間,CheckState()函數(shù)不會(huì)被載入到內(nèi)存,更不會(huì)被JITed(譯注:這里的JITed是指真正的編譯為機(jī)器代碼),除非它被調(diào)用。它存在于程序集文件里并不是本質(zhì)問(wèn)題。這樣的策略是增強(qiáng)(程序的)可伸縮性的,并且這樣只是一點(diǎn)微不足道的性能開銷。你可以通過(guò)查看.Net框架庫(kù)中Debug類而得到更深入的理解。在任何一臺(tái)安裝了.Net框架庫(kù)的機(jī)器上,System.dll程序集包含了Debug類的所有方法的代碼。由環(huán)境變量在編譯時(shí)來(lái)決定是否讓由調(diào)用者來(lái)調(diào)用它們。
你同樣可以寫一個(gè)方法,讓它依懶于不只一個(gè)環(huán)境變量。當(dāng)你應(yīng)用多個(gè)環(huán)境變量來(lái)控制條件屬性時(shí),他們時(shí)以or的形式并列的。例如,下面這個(gè)版本的CheckState會(huì)在DEBUG或者TRACE為真時(shí)被調(diào)用:
[ Conditional( "DEBUG" ),
Conditional( "TRACE" ) ]
private void CheckState( )
如果要產(chǎn)生一個(gè)and的并列條件屬性,你就要自己事先直接在代碼里使用預(yù)處理命令定義一個(gè)標(biāo)記:
#if ( VAR1 && VAR2 )
#define BOTH
#endif
是的,為了創(chuàng)建一個(gè)依懶于前面多個(gè)環(huán)境變量的條件例程(conditional routine),你不得不退到開始時(shí)使用的#if實(shí)踐中了。#if為我們產(chǎn)生一個(gè)新的標(biāo)記,但避免在編譯選項(xiàng)內(nèi)添加任何可運(yùn)行的代碼。
Conditional屬性只能用在方法的實(shí)體上,另外,必須是一個(gè)返回類型為void的方法。你不能在方法內(nèi)的某個(gè)代碼塊上使用Conditional,也不能在一個(gè)有返回值的方法上使用Conditional屬性。取而代之的是,你要細(xì)心構(gòu)建一個(gè)條件方法,并在那些方法上廢棄條件屬性行為。你仍然要回顧一下那些具有條件屬性的方法,看它是否對(duì)對(duì)象的狀態(tài)具有副作用。但Conditional屬性在安置這些問(wèn)題上比#if/#endif要好得多。在使用#if/#endif塊時(shí),你很可能錯(cuò)誤的移除了一個(gè)重要的方法調(diào)用或者一些配置。
前面的例子合用預(yù)先定義的DEBUG或者TRACE標(biāo)記,但你可以用這個(gè)技巧,擴(kuò)展到任何你想要的符號(hào)上。Conditional屬性可以由定義標(biāo)記來(lái)靈活的控制。你可以在編譯命令行上定義,也可以在系統(tǒng)環(huán)境變量里定義,或者從源代碼的編譯選擇里定義。
使用Conditional屬性可以比使用#if/#endif生成更高效的IL代碼。在專門針對(duì)函數(shù)時(shí),它更有優(yōu)勢(shì),它會(huì)強(qiáng)制你在條件代碼上使用更好的結(jié)構(gòu)。編譯器使用Conditional屬性來(lái)幫助你避免因使用#if/#endif而產(chǎn)生的常見的錯(cuò)誤。條件屬性比起預(yù)處理,它為你區(qū)分條件代碼提供了更好的支持。