Code Syntax Style: Multiple Attributes
Multiple attributes in C# can be written in different ways: you can join several attributes in the same square brackets section or use several sections for different attributes. ReSharper allows you to specify the style for multiple attributes and enforce this style in the desired scope.
Rider also provides multiple formatting rules for attributes. You can configure these rules in Rider settings (Ctrl+Alt+S), for example, go to the page and check the preferences on the Line breaks and wrapping tab.
Rider helps you apply attributes style 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.
Applying style preferences for attributes
By default, multiple attributes are checked for compliance with your preferences and if they do not comply, Rider highlights such declarations and suggests the corresponding quick-fix or fix in scope.
Your preferences may say that the attributes should be on separate sections:
... or into a single section:
Another option to enforce preferences for multiple attributes 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 apply attributes style with custom Code Cleanup profile
- 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 Arrange attributes 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 enforce your preferences:
- Choose Code | Code Cleanup in the main menu.
- In the Code Cleanup dialog that opens, select the newly created profile.
- Click OK. Rider will enforce your preferences in the selected scope.
Configuring preferences for attributes style
Your attributes 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.
To configure preferences of attributes style
- Go to the page of Rider settings (Ctrl+Alt+S), and then select the Code Style tab.
- In the Attributes category select the value for the Join or separate attributes in section according to your coding practices/standards.
- The selectors in the right column allow you to set severity levels of code inspections detecting code that differs from your preferences.
- Rider also provides multiple formatting rules for attributes. You can configure these rules in Rider settings (Ctrl+Alt+S), for example, go to the page and check the preferences on the Line breaks and wrapping tab.
- 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.
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