JetBrains Rider 2017.2 Help

Using Auto-Properties

Auto-implemented properties (also known auto-properties) allow declaring type properties that do not have additional logic in a simpler way. By default, JetBrains Rider encourages using of auto-properties when possible, but this behavior is configurable.

By default, JetBrains Rider highlights most of the properties that could be converted to auto-properties and suggests the corresponding quick-fix or fix in scope:

Use auto-property quick-fix

If you do not want JetBrains Rider to suggest this, you can disable the code inspection that detects it (Convert property to auto-property). In this case, properties with backing fields are not highlighted and quick-fixes are not suggested, but you can still apply the conversion with the context action or with the corresponding refactoring:

To auto-property context action

The reverse functionality of converting existing auto-properties to properties with backing field is also available with the corresponding context action. You can also generate default bodies for property accessors using the To compound property context action:

To property with backing field context action

Another option to convert properties to auto-properties 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 convert properties to auto-properties with custom code cleanup profile

  1. Press Ctrl+Alt+S, or alternatively choose File | Settings on Windows and Linux or Rider | Preferences on macOS.
  2. Go to the Code Cleanup settings page: Editor | Code Cleanup.
  3. Create a new profile as described in the Code Cleanup section. In the Selected profile settings section for the new profile, tick the Use auto-property, if possible check box. Optionally, you can enable other code cleanup tasks in this profile.
  4. Click Save to apply the modifications and let JetBrains 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.
  5. Select the scope where you want to use auto-properties:
    • Set the caret anywhere in the file to use auto-properties to the file.
    • Select one or more items in the Solution Explorer to use auto-properties in the files under these nodes and their child items.
  6. Choose Code | Code Cleanup in the main menu.
  7. In the Code Cleanup dialog that opens, select the newly created profile.
  8. Click OK. JetBrains Rider will use auto-properties in the selected scope.
Last modified: 21 November 2017