Organize Your Code with Named Regions

MSDN Blogs > The Ultimate Visual Studio Tips and Tricks Blog > Organize Your Code with Named Regions
Tips Search
  • Advanced search options...

If you like the tips then you'll love the book!

Order your copy today:
http://www.amazon.com/gp/product/0735649928

Organize Your Code with Named Regions

22 Feb 2011 1:00 AM
  • Comments 10

 

Versions: 2005, 2008, 2010

Code: vstipEdit0095

 

 

Did you know you can create named Regions that can be used to organize your code? Let’s take a look at how to do it.

 

Creating Named Regions

C++


In C++ you create regions by using “#pragma region” with label and “#pragma endregion” (case-specific):

image

 

 

C#

For C# you can eliminate the “pragma” keyword and just use “#region” with label and “#endregion” (case-specific):

image

 

 

VB

Visual Basic is just as easy as C# and uses a similar syntax of “#Region” with label and “#End Region” (not case-specific):

image

 

 

 

Value of Named Regions

The value of creating Regions is twofold. First, they travel with the code so are shared by all team members when using source control. Second, they become part of document outlining and can be collapsed or expanded to further organize you code:

image

, , , , , , , , ,
Comments
  • C# Regions
    22 Feb 2011 7:00 AM

    Zain,

    FYI, named C# regions do not require quotes.

    Thanks,

    Scott Blomfield

  • dkil1972
    22 Feb 2011 7:45 AM

    Using regions is like putting the toilet lid down without flushing.

  • 22 Feb 2011 8:24 AM

    Scott -- Yeah i struggled with that one for a bit but decided to show them with quotes for consistency with the VB ones

    dkil1972 -- So...Regions are out for you? :)

  • Casey Watson
    22 Feb 2011 5:18 PM

    You'd better watch out there Zain... you're liable to ruffle a few feathers. In my experience, developers have strong feelings (for and against) code regions ;)

  • 22 Feb 2011 5:25 PM

    Hehehe thanks Casey :)

    Thankfully I can claim to be a conscientious objector in this particular battle.  To paraphrase the Fox News tagline:  I report, you decide.

    Z

  • Josh
    22 Feb 2011 6:43 PM

    Yeah, I have to agree with dkil1972. Regions always seemed like toddler refactoring to me. I'll just push everything under this here... TADA! It's clean!

  • Isaac
    23 Feb 2011 6:11 AM

    Large Code Regions = an excuse to not bother adhering to SRP :-)

  • 23 Feb 2011 7:10 AM

    Yeah... there are some really strong opinions about regions in source code.  Richard Banks has started an "Anti-Region Campaign" on his blog and he lists some reasons why he doesn't like them:  www.richard-banks.org/.../anti-region-campaign.html

  • Chris Marisic
    24 Feb 2011 7:08 AM

    I use resharper to autoblock all of my code into regions, region for using statements, region for members, fields, ctors, etc. This way you can collapse to outline and only need to expand the method or 2 you're actively developing. Most times things like using statements, fields, ctors and autoproperties are all just noise anyway.

  • Clint
    2 Apr 2012 3:51 AM

    Chris: How are you getting ReSharper to autoblock your code into regions?  I have ReSharper but haven't seen/found that.  I've been using nArrange to do it, but that tool is getting old and not working in all WPF code behind files.

Page 1 of 1 (10 items)
Leave a Comment
  • Please add 6 and 2 and type the answer here:
  • Post
Options