JetBrains Rider 2017.2 Help

Code Syntax Style: Bodies of Function Members

Starting from C# 6.0, you can declare function members using expression bodies, which look very similar to lambda expressions. You can use expression-bodied methods and properties to further simplify the syntax of simple implementations.

If you prefer to stick to either expression-bodied or block-bodied implementations for simple function members, JetBrains Rider lets you configure your preferences separately for different kinds of members and maintain the consistency of your preferences throughout your codebase.

JetBrains Rider helps you enforce preferences for expression-bodied functions 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.

Enforcing preferences for expression-bodied functions

JetBrains Rider can help you check all simple members for compliance with your preferences and if they do not comply, it highlights such implementations and suggests the corresponding quick-fix or fix in scope. Default JetBrains Rider's preferences say that expression body is preferred for properties, indexers, and events:

JetBrains Rider. 'To expression body' quick-fix

For all other kinds of members, suggestions are disabled by default. However, you can configure your preferences in a different way, so that, for example, JetBrains Rider suggests to convert expression-bodied methods to block bodies:

JetBrains Rider. 'To statement body' quick-fix

Another option to enforce preferences for expression-bodied functions 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 preferences for expression-bodied functions 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 Apply code body style 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 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.
  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 enforce your preferences in the selected scope.

Configuring preferences for expression-bodied functions

Your function body 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 for expression-bodied functions

  1. Go to the Editor | Code Style | C# page of JetBrains Rider settings (Ctrl+Alt+S), and then select the Code Style tab.
  2. Modify settings in the Code body category according to your coding practices/standards.
  3. By default, JetBrains Rider applies heuristics to decide whether to convert block bodies of methods to expression bodies. Among other things, this means that JetBrains Rider will not suggest expression bodies for void methods and for methods that contain a lambda expression.
    You can simplify this logic by clearing the Apply style heuristics check box. In this case, the logic is simple: if you choose to use expression body for some kind of members, JetBrains Rider will suggest expression body if the declaration of a member of this kind consists of a single statement.
  4. The selectors in the right column allow you to set severity levels of code inspections detecting code that differs from your preferences.
  5. 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.
Last modified: 17 November 2017