Code Syntax Style: Null checking pattern
When checking an expression for null with the type-testing 'is' operator, you can choose between two null-checking patterns:
Use the 'not null' pattern that makes the expression more readable.
Use the object pattern syntax `{ }` that makes the expression more flexible, allowing you to declare a local variable after it.
ReSharper helps you enforce style preferences for null-checking patterns 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 preferences for null-checking patterns
By default, ReSharper highlights object pattern syntax { } in null-checking expressions and suggests replace them with the not null pattern:
If you prefer to use the { } pattern, you can change the corresponding preferences and ReSharper will help you replace not null patterns accordingly:
Another option to enforce your preferences for null-checking patterns 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 null-checking pattern style with custom Code Cleanup profile
Select from the main menu or press Alt+R O.
Go to the cleanup profiles settings page: .
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 null checking pattern style checkbox. Optionally, you can enable other code cleanup tasks in this profile.
Click Save in the Options dialog 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 list. For more information, see manage and share resharper settings.
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.
Do one of the following:
Press Control+Alt+F or choose from the main menu .
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 that opens, select the newly created profile .
Click Run. ReSharper will enforce your preferences in the selected scope.
If you want to enforce style preferences for null-checking patterns without opening the Code Cleanup dialog to choose a profile, you can bind the created profile to the silent cleanup and run it by pressing Control+Shift+Alt+F. You can also create a custom cleanup profile that would combine arranging null-checking pattern style with other code style tasks.
To apply null-checking pattern style together with all other formatting and syntax style rules to the selected code block, Alt+Enter and choose .
You can enforce style preferences for null-checking patterns every time you save changes in a file to make sure that your edits always comply with your code style.
Automatically enforce style preferences for null-checking patterns on saving changes
Select from the main menu or press Alt+R O.
Go to the cleanup profiles settings page: .
Select your custom Code Cleanup profile and click Set as default (the default profile is also used for silent cleanup).
Go to the options page and select Automatically run cleanup when saving a file.
Optionally, you can restrict automatic cleanup to specific files by a file mask. You can also select Only changed parts of file to make sure that cleanup is applied to the code affected by your changes, and the rest of the code in the file is not modified.
Click Save in the dialog 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 list. For more information, see manage and share resharper settings.
The next time you finish editing and save the file (Ctrl+S) or all files (Ctrl+Shift+S), ReSharper will clean up the affected files using the selected profile. If the default cleanup profile is not selected, ReSharper will prompt you choose one of the profiles.
Configure preferences for null-checking patterns
Your null-checking pattern 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.
Go to the page of ReSharper options (Alt+R, O).
In the Patterns category, under Null checking pattern style select '{}' pattern or 'not null' pattern.
The Notify with selectors in the right column allow you to set severity levels of code inspections detecting code that differs from your preferences.
Click Save in the Options dialog 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 list. For more information, see manage and share resharper settings.
Applicability in different languages
This feature is supported in the following languages and technologies:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| | | | | | | | | | | | | | |
