Making Fields Readonly
It is often reasonable to use the
'readonly' keyword for the fields
that are assigned in the declaration or in a constructor and only have read usages.
By default, ReSharper suggests you making a field readonly if the above conditions are met. It
such fields and suggests the corresponding
fix in scope:
If you do not want ReSharper to suggest you this, you can change the severity level of 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 compiler error),
ReSharper detects the error and suggests fixing it by removing the 'readonly' keyword from the filed:
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
- Open the Code Cleanup options: ReSharper | Options | Code Editing | Code Cleanup.
- Create a new profile as described in the Configuring Code Clenup section. In the Selected profile settings section for the new profile tick the Make field read-only, if possible check box.
- Click Save to apply the modifications and let ReSharper 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 Managing and Sharing ReSharper Settings.
Select the scope where you want to make fields readonly:
- Set 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.
Do one of the following:
- Choose on the main menu.
- Press Ctrl+Alt+F.
- Right-click anywhere in the text editor or right-click the selection and choose Cleanup Code in the context menu.
- In the Code Cleanup dialog box that opens, select the newly created profile in the Available Profiles area.
- Click Run. ReSharper will make fields readonly in the selected scope according to your preferences.
If you want to make fields readonly without opening the Code Cleanup dialog box, you can bind the created profile to the silent cleanup and run it simply by pressing Ctrl+Shift+Alt+F. You can also create a custom cleanup profile that would combine making fields readonly with other code style tasks.
This feature is supported in the following languages/technologies:
- Naming Style
- Navigating Between Code Issues
- Finding Out What Is Wrong with Your Code
- Code Formatting Rules
- File and Type Layout
- File Header Style
- Namespace Imports Assistance
- Implicit/Explicit Typing
- Using Auto-Properties
- Making Fields Readonly
- Attributes Style
- Arranging Modifiers
- Arranging Optional Member Qualifiers
- Reformatting XML Doc Comments
- Removing Code Redundancies