Code Syntax Style: Implicit/Explicit Typing ('var' Keyword)
Using implicitly typed local variables (also known as var
keyword) introduced in C# 3.0 has become quite popular as it improves readability in many scenarios. By default, ReSharper also encourages using of var
keyword, but preferences of its usage are flexibly configurable — for example, you can opt for using explicit types in specific cases or everywhere and JetBrains Rider will help you enforce your preferences.
Starting from C# 7.0, you can declare local variables when deconstructing tuples. If you prefer var
in such declarations, you can additionally configure a style to use joined or separated notation, that is, for example: var (x, y) = GetTuple();
or (var x, var y) = GetTuple();
.
Another C# 7.0 feature is discards, which also allows using var
to make sure that there are no conflicts with variables in the scope that may be named _
. JetBrains Rider allows you to configure a style to always use var
with discards where appropriate.
Enforcing preferences of using 'var' keyword
JetBrains Rider checks all local variables for compliance with your preferences and if they do not comply, JetBrains Rider highlights such declarations and suggests the corresponding quick-fix or fix in scope.
By default, JetBrains Rider's preferences say that 'var' keyword is preferred: If you change your preference, JetBrains Rider will help you to use explicit types:
Another option to enforce preferences of 'var' keyword usage in a bulk mode is code cleanup. You can either run code cleanup with one of the default profiles Full Cleanup or Reformat & Apply Code Style, or create and run a custom profile solely targeted at your specific task as described below.
To apply preferences of using 'var' keyword with custom Code Cleanup profile
Press Ctrl+Alt+S, or alternatively from the main menu, choose on Windows and Linux or on macOS.
Go to the Code Cleanup settings page:
.Create a new profile as described in the To create a new custom cleanup profile section. In the Selected profile settings section for the new profile, tick the Enforce 'var' keyword usage settings checkbox. Optionally, you can enable other code cleanup tasks in this profile.
Click Save to apply the modifications and let JetBrains Rider choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see layer-based settings.
-
Select the scope where you want to enforce your preferences:
Set the caret anywhere in the file to enforce your preferences to the file.
Select one or more items in the Solution Explorer to enforce your preferences in the files under these nodes and their child items.
Choose Code | Code Cleanup in the main menu.
In the Code Cleanup dialog that opens, select the newly created profile.
Click OK. JetBrains Rider will enforce your preferences in the selected scope.
Configuring preferences of using 'var' keyword
Your 'var' keyword usage preferences are saved using the mechanism of layer-based settings. Among other things, this mechanism allows you to maintain different preferences for different solutions as well as to keep these preferences under a VCS and automatically share them with your team members.
To configure preferences of using 'var' keyword
Go to the page of JetBrains Rider settings Ctrl+Alt+S, and then select the Code Style tab.
- Modify settings in the 'var' usage in declarations category according to your coding practices/standards. You can set different preferences of using 'var' or explicit type for different types:
For built-in types — applies to C# built-in types.
For simple types — applies to types without generic parameters.
Elsewhere — applies to generic types and deconstruction declarations.
By default, JetBrains Rider will suggest joined notation for multiple
var
's in deconstruction declarations, for examplevar (x, y) = GetTuple();
. You can select Prefer separate declarations for deconstructed variables to opt for separate notation, for example(var x, var y) = GetTuple();
.By default, JetBrains Rider suggests using standalone
_
for discards, for example(_, _) = (0, 1);
. You can select Use 'var' keyword for discards to always usevar
with discards where appropriate thus making sure that there are no conflicts with variables in the scope that may be named_
.The selectors in the right column allow you to set severity levels of code inspections detecting code that differs from your preferences.
Click Save to apply the modifications and let JetBrains Rider choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see layer-based settings.