JetBrains Rider 2017.2 Help

Code Syntax Style: Built-In Type References

The C# type keywords and .NET Framework type names are interchangeable with 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.

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.

Enforcing 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.

Built-in type usage style quick-fix

If you change your preference, JetBrains Rider will help you use .NET Framework type names:

Built-in type usage style quick-fix

Another option to enforce preferences for C# built-in types in a bulk mode is code cleanup. You can either run code cleanup with the default profile Default: Full Cleanup or run the cleanup with a custom profile solely targeted at your specific task as described below.

To apply preferences for C# built-in type references with custom Code Cleanup profile

  1. Press Ctrl+Alt+S, or alternatively choose File | Settings on Windows and Linux or Rider | Preferences on macOS.
  2. Go to the Code Cleanup settings page: Editor | Code Cleanup.
  3. Create a new profile as described in the Code Cleanup section. In the Selected profile settings section for the new profile, tick the Fix built-in type references check box. Optionally, you can enable other code cleanup tasks in this profile.
  4. 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 drop-down list. For more information, see layer-based settings.
  5. 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.
  6. Choose Code | Code Cleanup in the main menu.
  7. In the Code Cleanup dialog that opens, select the newly created profile.
  8. Click OK. JetBrains Rider will enforce your preferences in the selected scope.

Configuring preferences for referencing C# built-in types

Your built-in type naming 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 for C# built-in types

  1. Go to the Editor | Code Style | C# page of JetBrains Rider settings (Ctrl+Alt+S), and then select the Code Style tab.
  2. Modify settings in the Built-in type naming category according to your coding practices/standards.
  3. The selectors in the right column allow you to set severity levels of code inspections detecting code that differs from your preferences.
  4. 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 drop-down list. For more information, see layer-based settings.
Last modified: 23 November 2017