关闭

用好C#中的#region指令 实现良好的代码组织

发表于:2010-9-14 10:44

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:朱祁林(cnblogs)    来源:51Testing软件测试网采编

  这篇文章我将不会去介绍如何使用#region指令。因为每个C#开发人员都应该见过和使用过#region指令的。这篇文章将讨论如何在代码中正确的使用它。使用#region就是将一些有关联的代码组织在一起,然后折叠起来。这样你就在一个函数中看不到很长的令人头痛的代码段。例如:

public void DoSomething()  
{    
bool shouldIDoSomething;     
#region Decide 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中。如果把它折叠起来。看起来就会很整洁。是吧?

public void DoSomething()  
{    
bool shouldIDoSomething;     
[Decide if I should do something]     
if(shouldIDoSomething)    
{done++;    
}} 

  我们只是把一些代码和一些变量组合起来放在#region中。如果你在仔细想想,其实我们相当与创建了一个新的函数,只是将这些方法内置到当前方法中。一个函数只做单一的一件事情,这是Clean Code这本书的一个原则。为什么我们不把它提取为一个方法呢,这样一来,一个函数就只做一件事情了。

public void DoSomething(){    
if(ShouldIDoSomething())    
 {done++;  }}   
private bool ShouldIDoSomething(){    
if(needToDoSomething && haventDoneSomethingThisDay)  
shouldIDoSomething = true;    
else    
 {  
// do some other logic to decide   
and set shouldIDoSomething to some value  }} 

  这样看起来就清楚很多,因为我们降低了之前的DoSomething函数的复杂度。两个函数可以分开测试,确保没有逻辑错误。

  小段总结1:  #region 不适合在大方法中使用,当你在一个方法中使用#region 的时候,停下来想想你刚刚写了什么代码?大多数时候,你可以将这些代码段独立成一个函数。

  看看下面这段非常漂亮的代码:

#region Get Customer   
public void GetCustomer(){    
// code to get the customer}   
#endregion   
#region Save Customer   
public void SaveCustomer(){    
// code to save the customer}   
#endregion 

  将它折叠之后,变成下面这样:

[Get Customer] [Save Customer] 

  这样做很容易阅读吗?这样做的目的是什么,我不明白?代码折叠就会变得更好?我觉得这样做只会让代码更难以阅读,因为你每次要看region中的代码,你都要展开一次。

  小段总结2:不要因为你能,你就使用#region 。

21/212>
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号