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.
Similarly to other languages, all C++ code style preferences can be applied in the desired scope with a single command using either Fix in scope or Code cleanup.
ReSharper provides the following code style assistance features in C++:
- Managing and applying code formatting rules
- Naming style
- Arranging cv-qualifiers
- Include directive style
- Default pointer initializer style
- File header style
Managing and applying code formatting rules
An important aspect of code style is how to format the code, i.e. 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, etc.
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, code templates and refactorings. The formatting rules can be also 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 .editorconfig files.
As an alternative to digging through options pages, you can select a block of code, press Alt+Enter and choose to configure formatting rules applicable to this block, observing the changes right in this block.
Naming style
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, etc.
Naming rules in C++ are applied to generated code. Out of the box, ReSharper provides a naming rule for each type of identifier. If necessary, you can configure naming rules according to your preferences.
Arranging cv-qualifiers
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 const
and volatile
modifiers.
Include directive style
On the page of ReSharper options, you can specify whether to use forward or backward slash as a path separator in include directives in generated code. You can also specify whether or not to generate forward declaration in the header file.
Default pointer initializer style
You can specify 0
, nullptr
or NULL
as the preferred initializer for pointer initializers, e.g.: 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.
The configured file header could be inserted in new files if you create them using file templates. To do so, you should add a template parameter and associate the 'File header' macro with it.
If you want to apply the file header to existing files, you can do it with the code cleanup.