Making Fields Readonly
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, 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:
If you do not want Rider to suggest this, you can disable the code inspection that detects it (Field can be made readonly).
The reverse functionality is also available. If you decide to change a readonly field later in your code (which leads to a compiler error), 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 default profile Default: Full Cleanup or run the cleanup with a custom profile solely targeted at your specific task as described below.
To add the 'readonly' keyword to fields that only have read access
- Press Ctrl+Alt+S, or alternatively choose on Windows and Linux or on macOS.
- Go to the Code Cleanup settings page: .
- Create a new profile as described in the Code Cleanup section. In the Selected profile settings section for the new profile, tick the Make field read-only, if possible check box. Optionally, you can enable other code cleanup tasks in this profile.
- Click Save to apply the modifications and let 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.
- Select the scope where you want to make fields readonly:
- Choose Code | Code Cleanup in the main menu.
- In the Code Cleanup dialog that opens, select the newly created profile.
- Click OK. Rider will make fields readonly in the selected scope.
See Also
Procedures:
- Naming Style
- Managing and Applying Code Formatting Rules
- File and Type Layout
- File Header Style
- Code Syntax Style: Namespace Imports
- Code Syntax Style: Implicit/Explicit Typing
- Using Auto-Properties
- Making Fields Readonly
- Code Syntax Style: Multiple Attributes
- Code Syntax Style: Modifiers
- Code Syntax Style: Optional Member Qualifiers
- Reformatting XML Doc Comments
- Removing Code Redundancies