Home » c# » Equivalent of #region for C++

Equivalent of #region for C++

Posted by: admin November 30, 2017 Leave a comment

Questions:

What’s the C++ equivalent of #region for C++ so I can put in custom code collapsible bits and make my code a little easier to read?

Answers:

The Region keyword is IDE specific and affects rendering in Visual Studio. The nearest equivalent is #pragma Region which is applicable to Visual Studio only .

Code example from MSDN

// pragma_directives_region.cpp
#pragma region Region_1
void Test() {}
void Test2() {}
void Test3() {}
#pragma endregion Region_1

int main() {}

Questions:
Answers:

In addition to #pragma region#pragma endregion for Visual Studio, many IDEs support the following syntax for regions in any {}-delimited, //-commented language:

//{ Region header text.
…
//}

Notable examples include Code::Blocks and FlashDevelop, and any other editor that uses the Scintilla editing component, such as Notepad++, Geany, Komodo Edit, and many more.

Questions:
Answers:

There isn’t an equivalent in C++. However IDEs should be able to collapse sections.

It is also possible to use something like this:

#pragma region

#pragma endregion A comment about the region.

But probably not very portable

Questions:
Answers:

There is no equivalent. The #region feature is part of the C# specification.

C++ has no such equivalent. You could possibly mimic it with specially formatted comments, but this would be editor specific.

For Visual Studio you can use:

#pragma region name
...
#pragma endregion name

Questions:
Answers:

I’ve been using

#ifndef ANY_NAME_FOR_THIS_REGION
    ...
#endif

for several projects during the last couple of years and that suits me (including collapsible blocks). as an addition, i can disable the block using #define ANY_NAME_FOR_THIS_REGION just above it.

Questions:
Answers:

There is no equivalent.

Most good editors or IDEs will let you collapse functions, if not also if/else/while/for/etc.

Questions:
Answers:

Just an addition to other answers. The region definition varies from IDE to IDE.

For Mac development in Xcode you can use a pragma:

#pragma mark

Questions:
Answers:

C++Builder does support this, but you must declare the region as:

#pragma region BLAH

.....

#pragma end_region

You must use end_region for C++Builder, but it will work, and it will collapse the region!

Questions:
Answers:

Kate, KDevelop and all other text editors and IDEs which use Katepart supports marking regions with //BEGIN and //END markers.

// BEGIN GPT entity types
#define GPT_ENT_TYPE_UNUSED \
    {0x00000000,0x0000,0x0000,0x00,0x00,{0x00,0x00,0x00,0x00,0x00,0x00}}
#define GPT_ENT_TYPE_EFI \
    {0xc12a7328,0xf81f,0x11d2,0xba,0x4b,{0x00,0xa0,0xc9,0x3e,0xc9,0x3b}}
#define GPT_ENT_TYPE_MBR \
    {0x024dee41,0x33e7,0x11d3,0x9d,0x69,{0x00,0x08,0xc7,0x81,0xf3,0x9f}}
// END

You will be able to collapse a region defined in such way.

Questions:
Answers:

The first answer from this question mentions another alternative. It is not applicable in all situations, though.

Method: Use {…} instead which natively supports code collapsing in Visual Studio.

  1. Enable option: Tools -> Options -> Text Editor -> C/C++ -> Formatting -> OutLine Statement Blocks -> True.

  2. Put your in different scopes {…}, then it will collapse the code in different scopes:

Scoped code collapsing example