JetBrains Rider
 
2023.1
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
You are viewing the documentation for an earlier version of JetBrains Rider.
  1. Code style and cleanup
  2. Syntax styles
  3. Optional member qualifiers

Code Syntax Style: Optional Member Qualifiers

Last modified: 18 May 2022

In C#, you can qualify instance members with this keyword, and qualify static members with type name or a base type name. These qualifiers help you disambiguate members hidden by local variables or method parameters. In all other cases, these modifiers are optional, and you can decide for yourself whether to use them or not. With JetBrains Rider, you can configure your preferences for using optional modifiers and enforce these preferences.

JetBrains Rider helps you adjust optional member qualifiers 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 style preferences for optional member qualifiers

By default, JetBrains Rider treats all optional member qualifiers as redundant and suggests removing them.

Suggestion to remove redundant qualifier

If you prefer to use optional qualifiers, you need to specify it explicitly as described below. For example, you may prefer to qualify static methods with the type where they are declared:

Preferences for member qualifiers

As soon as you change the preferences, JetBrains Rider will treat the same code differently and suggest the corresponding corrections:

Suggestion to qualify with the base type name

note

Preferences for member qualifiers are not applied to generated code. By default, JetBrains Rider provides the list of file masks and regions for generated code typically produced by Visual Studio (for example, Windows Form Designer-generated code). If necessary, you can edit the list of generated items on the Editor | Inspection Settings | Generated Code page of JetBrains Rider settings Ctrl+Alt+S.

Another option to enforce preferences for member qualifiers 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 member qualifiers with custom Code Cleanup profile

  1. Press Ctrl+Alt+S or choose File | Settings (Windows and Linux) or JetBrains Rider | Preferences (macOS) from the menu .

  2. Go to the cleanup profiles settings page: Editor | Code Cleanup.

  3. 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 Arrange qualifiers checkbox. Optionally, you can enable other code cleanup tasks in this profile.

  4. 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, 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. Press Ctrl+E, C or choose Code | Reformat and Cleanup… from the main menu .

  7. In the Reformat and Cleanup Code dialog that opens, select the newly created profile and choose another scope if needed. .

  8. Click OK. JetBrains Rider will enforce your preferences in the selected scope.

If you want to apply preferences for member qualifiers 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 Ctrl+E, F. You can also create a custom cleanup profile that would combine applying the preferences with other code style tasks.

To apply preferences for optional member qualifiers together with all other formatting and syntax style rules to the selected code block, Alt+Enter and choose Reformat and cleanup | Reformat & apply syntax style.

You can adjust optional member qualifiers 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

  1. Press N/A or select Git | Commit from the main menu.

  2. In the Commit tool window, click Show Commit Options and in the Before Commit area, select the Cleanup with... checkbox.

  3. Click Choose profile and choose your custom Code Cleanup profile.

  4. Click Commit or Commit and Push. JetBrains Rider will run code cleanup on the ranges staged for the commit, and then commit the changes.

You can adjust optional member qualifiers 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 Ctrl+S or Ctrl+Shift+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 adjust optional member qualifiers on saving changes

  1. Press Ctrl+Alt+S to open the IDE settings and select Tools | Actions on Save.

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

  3. 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 of optional member qualifiers

Your member qualifiers style 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.

tip

Code style features that only change whitespaces, tabs, and line breaks are configurable in formatting preferences.

See also

Concepts

Procedures

External Links