Code Syntax Style: Built-In Type References
The C# type keywords and .NET Framework (CLR) type names are interchangeable for built-in C# types. If you prefer to stick to one or another style for built-in type names, JetBrains Rider can help you maintain your preference.
You can maintain separate styles for static member access (for example, CLR type names — var str = String.Empty;) and for locals, members, and parameters (for example, keywords — void Foo(string str){ }.
JetBrains Rider helps you enforce preferences for C# built-in types in the existing code and takes your preferences into account when it produces new code with code completion and code generation features, applies code templates and performs refactorings.
Enforce preferences for C# built-in types
JetBrains Rider checks all built-in type references for compliance with your preferences and if they do not comply it highlights such references and suggests the corresponding quick-fix or fix in scope. Default JetBrains Rider's preferences say that the C# keywords are preferred.
If you change your preference, JetBrains Rider will help you use .NET Framework type names:
Another option to enforce preferences for C# built-in types in a bulk mode is code cleanup. You can either run code cleanup with one of the built-in profiles Full Cleanup or Reformat & Apply Syntax Style, or create and run a custom profile solely targeted at your specific task as described below.
Apply preferences for C# built-in type references with custom Code Cleanup profile
Press Control+Alt+S or choose (Windows and Linux) or (macOS) from the menu .
Go to the cleanup profiles settings page: .
Create a new profile as described in the Create a new custom cleanup profile section. In the Selected profile settings section for the new profile, tick the Fix built-in type references checkbox. Optionally, you can enable other code cleanup tasks in this profile.
Click Save in the Settings dialog 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, refer to layer-based settings.
Select the scope where you want to enforce your preferences:
Place 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.
Press Control+R, C or choose from the main menu .
In the Reformat and Cleanup Code dialog that opens, select the newly created profile and choose another scope if needed. .
Click OK. JetBrains Rider will enforce your preferences in the selected scope.
If you want to enforce preferences for C# built-in types without opening the Reformat and Cleanup Code dialog to choose a profile, you can bind the created profile to the silent cleanup and run it by pressing Control+R, G. You can also create a custom cleanup profile that would combine applying the preferences with other code style tasks.
To apply preferences for C# built-in type references together with all other formatting and syntax style rules to the selected code block, Alt+Enter and choose .
You can enforce preferences for C# built-in types in code that you have recently modified and are going to commit to Git. JetBrains Rider will run the selected cleanup profile before committing.
Clean up code before committing it to Git
Press Control+K or select from the main menu.
In the Commit tool window, click
and in the Commit Checks area, select the Cleanup with... checkbox.Click Choose profile and choose your custom Code Cleanup profile.
Click Commit or Commit and Push. JetBrains Rider will run code cleanup in files staged for the commit, and then commit the changes.
You can enforce preferences for C# built-in types every time you save changes in a file to make sure that your edits always comply with your code style. Note that this will only happen when you save changes explicitly with Control+S or Control+S and will not be triggered by auto-saving. However, all auto-saved files are placed to the 'reformat and cleanup' queue and will be processed on the next explicit save.
Automatically enforce preferences for C# built-in types on saving changes
Press Control+Alt+S to open the IDE settings and then select .
Select Reformat and Cleanup Code, choose your custom Code Cleanup profile and whether to apply it to the whole file or only to the changed lines.
The next time you finish editing and save the file or all files , JetBrains Rider will clean up the affected files using the selected profile.
Configure preferences for referencing C# built-in types
Your built-in type references 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.
Configure preferences for C# built-in types
Go to the page of JetBrains Rider settings Control+Alt+S, and then select the Syntax Style tab .
Modify settings in the Built-in types category according to your coding practices/standards.
The selectors in the right column allow you to set severity levels of code inspections detecting code that differs from your preferences.
Click Save in the Settings dialog 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, refer to layer-based settings.
You can also change your preference of referencing C# built-in types right in the editor, where a corresponding issue is highlighted:
Change preference of referencing C# built-in types from the editor
Place the caret to a code issue highlighted by a JetBrains Rider's inspection.
Press Alt+Enter or click the action indicator to the left of the caret to open the action list.
In the action list, choose Inspection "Replace built-in type reference..." | Configure code style and then select a desired preference:
Your change will be saved using the smart save logic.
If you need to save the modified style preference in a shared settings layer, click the Configure code style menu item or press Enter when it is selected. JetBrains Rider will open the page of JetBrains Rider settings where you can modify your preference as needed, click Save To and then choose the desired settings layer.