It is often reasonable to use the 'readonly' modifier for fields that are assigned in the declaration or in a constructor and only have read usages. By default, JetBrains Rider suggests that you make a field readonly if the above conditions are met. It highlights such fields and suggests the corresponding quick-fix or fix in scope:
tip
With JetBrains Rider, you can also automatically arrange the order of modifiers and add or remove explicit private and internal. For more information, refer to Code Syntax Style: Modifiers.
The reverse functionality is also available. If you decide to change a readonly field later in your code (which leads to a compiler error), JetBrains Rider detects the error and suggests fixing it by removing the 'readonly' keyword from the field:
Another option to make fields readonly in a bulk mode is code cleanup. You can either run code cleanup with the Built-in: Full Cleanup profile or create and run a custom profile solely targeted at your specific task as described below.
Add the 'readonly' keyword to fields that only have read access
Press CtrlAlt0S or choose File | Settings (Windows and Linux) or JetBrains Rider | Preferences (macOS) from the menu .
Go to the cleanup profiles settings page: Editor | Code Cleanup.
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 Make field read-only, if possible 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 by choosing this layer from the Save selector. For more information, see layer-based settings.
Select the scope where you want to make fields readonly:
Place the caret anywhere in the file to make fields readonly to the file.
Select one or more items in the Solution Explorer to make fields readonly in the files under these nodes and their child items.
Press Ctrl0E,0C or choose Code | Reformat and Cleanup… 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 make fields readonly in the selected scope.
note
Code cleanup is 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 CtrlAlt0S.
If you want to make fields readonly 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 Ctrl0E,0F. You can also create a custom cleanup profile that would combine making fields readonly with other code style tasks.
Our website uses some cookies and records your IP address for the purposes of accessibility, security, and managing your access to the telecommunication network. You can disable data collection and cookies by changing your browser settings, but it may affect how this website functions. Learn more.
With your consent, JetBrains may also use cookies and your IP address to collect individual statistics and provide you with personalized offers and ads subject to the Privacy Notice and the Terms of Use. JetBrains may use third-party services for this purpose. You can adjust or withdraw your consent at any time by visiting the Opt-Out page.