Code Style Assistance in C++
ReSharper provides a lot of features for keeping your code neat and clean. Being tightly interwoven with the majority of other ReSharper's features, they help you produce code and change existing codebases according to the specific code style. The code style, which includes naming standards, formatting rules, and many other tiny aspects can be configured to a very detailed level and shared across your team.create a new custom profile to enable them.
Managing and applying code formatting rules
An important aspect of code style is how to format the code, that is, how to use whitespaces and blank lines to arrange and separate code blocks, whether and how to use tabs for indents, whether and how to wrap long lines, and so on.
The extensive set of ReSharper code formatting rules has a default configuration that takes into account default Visual Studio formatting options as well as numerous best practices. You can configure every detail of formatting rules and enforce the rules in your code. These rules are applied when ReSharper produces new code with code completion and code generation features, applies code templates and performs refactorings. The formatting rules can also be applied to the existing code in the current selection, current file, or in a larger scope up to the entire solution.
ReSharper stores formatting preferences using the mechanism of shared settings. You can configure formatting rules in options pages under the group. You can also store and share formatting settings in the EditorConfig and Clang-Format files.
As an alternative to digging through options pages, you can select a block of code, press Alt+Enter and choose configure formatting rules applicable to this block, observing the changes right in this block.to
Another alternative to tweaking individual formatting preferences is to learn formatting rules from an existing code sample, which can be a selected block , the current file, a set of files, one or more projects, or the entire solution. ReSharper will analyze the selected sample and list 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.
For more information, see Use formatting rules from existing code
ReSharper helps you define, control, and apply naming style for symbols in your code. Naming style is implemented as a set of rules, each of which targets specific identifiers with the set of constraints . Each rule can have one or more associated styles that define suffixes, prefixes, capitalization of compound words, and so on.
These rules are taken into account when ReSharper produces new code with code completion and code generation features, applies code templates and performs refactorings. ReSharper also helps you detect and fix violations of naming rules. If necessary, the automatic checkup of naming rules can be configured or disabled.
On the Alt+R, O), you can reset your ruleset to one of the predefined naming style schemes (STL, Google, LLVM, CamelCase, Microsoft). You can use these schemes as is or configure your own ruleset based on a predefined one.page of ReSharper options (
Customize naming ruleset
Select Alt+R O, then choose on the left.from the main menu or press
At the top-right corner of the page, use the Reset to Scheme selector to choose a naming style scheme to base your ruleset on.
You will see a list of identifiers and other items for which naming rules are configured.
To change the rule for an item, select it and click Edit or just double-click it. To add a rule for a non-listed item, click Add .
In the dialog that opens, you can configure the new or the modified rule:
In the left part of the dialog, you can specify the rule's description — it helps understanding, which kinds of identifiers the rule applies to. Other controls in the left part let you restrict the rule's applicability to specific identifiers by their kind, specifiers, and accessibility.
Note that specifiers are configured with tri-state checkboxes: a tick means only with this specifier, clear means only without this specifier, and a square means with and without this specifier. The illustration above shows a rule that will apply to
In the right part of the dialog, you can configure styles for the rule. You need at least one style. If you would like to allow other styles for this rule, click Add . When there are several styles for a single rule, ReSharper does not detect code style violation if a corresponding symbol name matches at least one of these styles. Otherwise ReSharper detects a code style violation and suggests renaming the symbol according to the default style (the first style in the list). To change the default style, use Move Up and Move Down buttons.
To configure a specific style, select it in the list and configure prefix, suffix, and choose a naming style.
To remove an unnecessary style, select it in the list and click Remove .
If necessary, you can disable detection of code style violations associated with this rule, allowing ReSharper to detect other code style violations. To do so, clear the Enable inspections checkbox.
Click Set to close the Edit Rule Settings dialog.
When you are back on the Naming Style settings page, use Move Up and Move Down buttons to change the priority of rules — if several rules match a specific identifier kind, the rule higher in the list applies. This means that rules with more restrictions should be placed higher than rules with less restrictions. For example, both rules Functions, and Public static functions apply to a
public staticfunction, so the Public static functions rule is placed higher in the list:
Click Save in the Options dialog to apply the modifications and let ReSharper choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see Manage and Share ReSharper Settings.
If you're working with a UE4 project, ReSharper 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 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:
ReSharper helps you arrange cv-qualifiers in generated code. On the page of ReSharper options, you can specify whether to put cv-qualifiers before or after the type specifier as well as the order of the
Include directive style
On the generated code. You can also specify whether or not to generate forward declaration in the header file.page of ReSharper options, you can specify whether to use forward or backward slash as a path separator in include directives in
Sorting of includes
ReSharper allows you to sort
#include directives, rearrange the existing groups and create new ones separated by blank lines.
When the caret is on an
#include directive, there are three context actions in the Sort #include directives submenu:
|Sort #include directives|
|Sort and regroup #include directives||This action merges all |
|Sort each #include group separately||This action sorts |
|Sort only current #include group||This action sorts the group that the caret is on.|
You can configure the ordering rules on the the Alt+R, O).page of ReSharper options (
ReSharper supports importing the sorting settings from a .clang-format file. When Read code style form .clang-format style is checked on the page of ReSharper options (Alt+R, O), the IncludeBlocks, IncludeCategories, IncludeIsMainRegex, and SortIncludes settings from your .clang-format file will be used to sort the
#include directives in the same way that clang-format does.
Sorting of includes can also be applied with Code Cleanup.
Default pointer initializer style
You can specify
NULL as the preferred initializer for pointer initializers, for example:
const char *foo = nullptr. You can change your preference on the page of ReSharper options.
File header style
Using file headers for copyright notices and other identifying messages is a common practice. ReSharper allows you to configure the default header text and automatically insert it into code files of your solution.
If you want to apply the file header to existing files, you can do it with the code cleanup.