C# region的作用

原文地址:http://www.cnblogs.com/zhuqil/archive/2010/09/07/about-region-preprocessor-directive.html

這篇文章我將不會去介紹如何使用#region指令。因為每個C#開發(fā)人員都應該見過和使用過#region指令的。這篇文章將討論如何在代碼中正確的使用它。使用#region就是將一些有關聯(lián)的代碼組織在一起,然后折疊起來。這樣你就在一個函數(shù)中看不到很長的令人頭痛的代碼段。例如:

publicvoidDoSomething()

{

boolshouldIDoSomething;

#regionDecide if I should do something

if(needToDoSomething&&haventDoneSomethingThisDay)

shouldIDoSomething=true;

else

{

//do some other logic to decide and set shouldIDoSomething to some value

}

#endregion

if(shouldIDoSomething)

{

done++;

}

}

當然這段代碼很簡單。在實際項目中,你可能看到上百行甚至更多的代碼在一個#region中。如果把它折疊起來。看起來就會很整潔。是吧?

publicvoidDoSomething()

{

boolshouldIDoSomething;

[DecideifI shoulddosomething]

if(shouldIDoSomething)

{

done++;

}

}

只是把一些代碼和一些變量組合起來放在#region中。如果你在仔細想想,其實我們相當與創(chuàng)建了一個新的函數(shù),只是將這些方法內(nèi)置到當前函數(shù)中。一個函數(shù)只做單一的一件事情,這是Clean Code這本書的一個原則。為什么我們不把它提取為一個函數(shù)呢,這樣一來,一個函數(shù)就只做一件事情了。

publicvoidDoSomething()

{

if(ShouldIDoSomething())

{

done++;

}

}

privateboolShouldIDoSomething()

{

if(needToDoSomething&&haventDoneSomethingThisDay)

shouldIDoSomething=true;

else

{

//do some other logic to decide and set shouldIDoSomething to some value

}

}

上面看起來就清楚很多,因為我們降低了之前的DoSomething函數(shù)的復雜度。兩個函數(shù)可以分開測試,確保沒有邏輯錯誤。

小段總結1:? #region 不適合在大方法中使用,當你在一個方法中使用#region 的時候,停下來想想你剛剛寫了什么代碼?大多數(shù)時候,你可以將這些代碼段獨立成一個函數(shù)。

看看下面這段非常漂亮的代碼:

#regionGet Customer

publicvoidGetCustomer()

{

//code to get the customer

}

#endregion

#regionSave Customer

publicvoidSaveCustomer()

{

//code to save the customer

}

#endregion

將它折疊之后,變成下面這樣:

[Get Customer]

[Save Customer]

這樣做很容易閱讀嗎?這樣做的目的是什么,我不明白?代碼折疊就會變得更好?我覺得這樣做只會讓代碼更難以閱讀,因為你每次要看region中的代碼,你都要展開一次。

小段總結2:不要因為你能,你就使用#region 。

再看下面這個例子

publicclassPriceCalculator

{

publicdecimalCalculatePrice()

{

decimalprice=100m;

decimaldiscount=CalculateDiscount();

returnprice*(1m-discount));

}

#regionDiscount Calculation

privatevoidCalculateDiscount()

{

decimaldiscount=0m;

if(CanApplyDiscount())

discount=0.05m;

returndiscount;

}

privatevoidCanApplyDiscount()

{

//some logic, other method calls

}

//some other discount calculation methods

...

#endregion

}

如果你將這個例子和本文中的第一個例子做下比較,你可能會看到它們的共同點。他們是相同的,不過一個是在類中,一個是在函數(shù)中,層級不同而已。這里在提一個原則:單一職責原則,一個類應該只有一個職責??瓷厦娴念?,你可以很容易看出它有兩個職責:價格計算和折扣計算。折扣計算的方法被放到一個#region中。同樣,可以將它們提取出來做為一個新類。

小段總結3:可以將一組相關的函數(shù)提取到一個職責單一的新類中。

那我們到底怎么使用 #region 呢。將東西用它來分組,它是非常有用的。在我寫的類中或多或少有幾個#region,用來對類中不同的結構進行分組。比如: fields, properties, methods, events, types等。如果你打開我寫的類文件,你會看到結構如下:

publicclassSomeClass

{

[Events]

[Fields]

[Properties]

[Methods]

}

總的來說:我將#region看成能控制閱讀源代碼的復雜度的一種方式。因為你可以將一些相關的代碼放在一個區(qū)域(#region)里面。但是,這不是你隨便就創(chuàng)建新方法或者新類的借口。其實Region并不能消除復雜度,它只是在你閱讀代碼的時候,隱藏了部分代碼。你必須通過寫出小巧,清晰,重點突出的方法和類,才能控制代碼的復雜度。當你做到這些的時候,你甚至會發(fā)現(xiàn)#region是不必要的。

本文翻譯:About #region preprocessor directive

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,563評論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,694評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,672評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,965評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,690評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 56,019評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,013評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,188評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,718評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 41,438評論 3 360
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,667評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,149評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,845評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,252評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,590評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,384評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,635評論 2 380

推薦閱讀更多精彩內(nèi)容