JetBrains Rider 2021.1 Help

Code Style. C++

On this page of JetBrains Rider settings, you can configure various aspects of code style in C++. Code style preferences are grouped in the following tabs:

Auto-detect formatting rules

Click this button to start analysis of code formatting used in the current solution to detect formatting rules that differ from your current settings. You will then be able to review the detected rules, change them as required, and save them to the desired settings layer or to a configuration file in the .editorconfig or .clang-format format.

Tabs and Indents

This page helps you specify how JetBrains Rider should format indents in your code when you type or when you reformat existing code.

Indentation-settings source

If there are .editorconfig files that affect your solution, preferences on this and other tabs with code style settings could be overridden by EditorConfig styles. You will see a yellow warning if at least one preference on the page is overridden by EditorConfig or Clang-Format styles for the current file, each overridden preference will also be highlighted with yellow. For example:

Code formatting options overridden by EditorConfig styles

Combine indentation and alignment in multiline constructs

If your preferences say that whitespaces should be used for indents, JetBrains Rider will also use whitespaces to align multiple constructs — for example, when function parameters on multiple lines are aligned by the first parameter:

void foo(int firstParameter, int secondParameter) { }

However, when you choose to use tabs for indents, there could be different ways for aligning multi-line constructs. JetBrains Rider lets you choose which of these ways to use when creating new and reformatting existing code.

You can configure preferences for aligning multi-line constructs with the How to align when tabs are used for indents option.

  • Use spaces (recommended, looks aligned on any tab size)
    When this option is selected, JetBrains Rider uses tabs for indents and spaces for alignment:

    Use spaces (recommended, looks aligned on any tab size)
    This is recommended option because code aligned with second and third options may lose alignment when viewed in an editor with a different tab size.

  • Only use tabs (inaccurate)
    When this option is selected, JetBrains Rider uses tabs for both indents and alignment, which may not result in precise alignment:

    Only use tabs (inaccurate)

  • Mix tabs and spaces for optimal fill
    When this option is selected, JetBrains Rider uses tabs for both indents and alignment adds necessary spaces for precise alignment.

    Mix tabs and spaces for optimal fill

Naming

On this tab, you can configure symbol naming rules for C++.

If you're working with a UE4 project, JetBrains Rider will automatically apply a naming ruleset corresponding to the Unreal Engine coding standard, which is not configurable. This means that the rules configured on the Editor | Code Style | C++ | Naming settings page will be ignored when you're working on a UE4 project. If you still want to used your configured ruleset instead of the Unreal Engine coding standard, you can disable the corresponding inspection.

JetBrains Rider: Applying UE4 naming conventions

Syntax Style

Preferences configurable on this tab help you enforce code syntax style— how to use interchangeable language syntax constructions. These preferences are taken into account when JetBrains Rider produces new code with code completion and code generation features, applies code templates and performs refactorings. They can also be applied to the existing code by using code cleanup with the corresponding settings.

The preferences with the Notify with selector have corresponding code inspections that notify you if this aspect of the syntax style in the inspected scope differs from the preferred style. Using the selectors, you can configure severity levels of the inspections.

Sort include directivesSelect this option to highlight any #include directives that violate the sorting order.
Type of slashes to use in include directivesUse this checkbox to choose the preferred path separator for include directives: forward slash or backward slash.
Prefer to use forward declarations if possibleIf this option is selected, auto-import puts the option to add a forward declaration before the option to insert an include directive.
Use paths relative to the source fileYou can use this selector to configure when JetBrains Rider may use relative paths in generated include directives.
Use angle brackets instead of quotesBy default, generated include directives are added in quotes, if necessary, you can use this selector to specify cases where generated include directives are added in angle brackets.
Default pointer initializer You can specify 0, nullptr or NULL as the preferred initializer for pointer initializers, for example: const char *foo = nullptr.
Use uniform initialization in member initializersBy default, JetBrains Rider uses C++03 style when generating initializers (for example when you generate constructors or apply a quick-fix that inserts initializer into an existing constructor). You can select this checkbox to enable uniform initialization in the above mentioned cases.
Prefer uniform initialization in NSDMIsThis option lets you configure how JetBrains Rider generates non-static data member initializations (NSDMIs) when applying its features. For example, when you apply a quick-fix Alt+Enter on the uninitialized field in the following code
class test { int field; };
JetBrains Rider will generate a uniform initialization int field{0}; when the option is enabled, and int field = 0; if the option is disabled.
Sort member initializers by the order of initializationThis option lets you enforce the order of member initializers in constructor initializer lists. Class members are initialized in the order they are declared in their containing class, so to minimize confusion and errors the common practice is to keep member initializers in the same order.
'auto' usage in variable typesPreferences in this section let you configure the usage of auto separately for numeric and non-numeric types. The default for non-numeric types is When type is evident, which means that the auto specifier will only be introduced in the situations where the deduced type is evident from the initializer expression.
Position of cv-qualifiersPreferences in this section let you configure whether the const keyword should be placed before or after the type it applies to, and which of the const and volatile qualifiers should go first.
Function declaration syntaxUse this option to configure whether to use trailing or regular return types in function declarations.
Prefer typedefs or type aliasesUse this option to specify the preferred way to define type synonyms: in the form of alias templates or type aliases. It also affects which syntax is used by the Introduce Typedef refactoring.
Nested namespacesUse this option to enforce the C++17 syntax for nested namespaces, which allows you to declare multi-level namespaces in a more concise manner.
Overriding functionsPreferences in this section let you configure which specifiers should be required on overriding functions and destructors.
BracesPreferences in this section let you define which braces can be omitted around single nested statements under the if statement and different kinds of loop statements. In addition to the straightforward Do not enforce > and Enforce always options, you can also opt to require braces only around statements that span several lines, or when the nested statement itself is multi-line.
Remove redundantUse this option to configure whether JetBrains Rider should remove optional braces that do not comply with the chosen preference.

Braces Layout

Use this tab to adjust the way JetBrains Rider arranges braces when it generates and reformats your code; in particular, there are several ways to position braces after if or for operators.

For every item, there is a preview pane in the bottom part of the page where you can observe changes after tweaking specific preferences.

Blank Lines

This page is used to configure line breaks in certain positions of source code. Options in this page are applied when JetBrains Rider reformats existing code or when you type new code. You can adjust the values and check the preview pane at the bottom of the page to see how your preferences affect the code.

The options that you configure on this tab apply in the following cases:

Line Breaks and Wrapping

This page is used to configure line breaks in certain positions of source code. Options in this page are applied when JetBrains Rider reformats existing code or when you type new code. You can adjust the values and check the preview pane at the bottom of the page to see how your preferences affect the code.

Spaces

This tab is used to configure automatic insertion/deletion of spaces in certain positions of your source code. You can adjust the values and check the preview pane at the bottom of the page to see how your preferences affect the code.

The options that you configure on this tab apply in the following cases:

Indentation and Alignment

You can use preferences on this page to specify how JetBrains Rider indents and aligns your code in specific cases. In the Indentation group, you can define how tabs and indents (that you can configure on the Code Editing | C++ | Formatting Style | Tabs and Indents options page) are applied in specific cases. In the Align multiple constructs group, you can define how code constructs that span multiple lines are aligned (you can specify the rules for breaking long lines on the Code Editing | C++ | Formatting Style | Line Breaks and Wrapping options page).

The options that you configure on this tab apply in the following cases:

Last modified: 07 April 2021