JetBrains Rider 2024.1 Help

Generate Formatting Members

Any type in .NET implements the ToString() method, which returns a string representation of an object of the type. To return a meaningful string for our types, we often need to override the ToString() method.

JetBrains Rider allows you to automate this routine with the Generate formatting members command.

Depending on the target C# version, JetBrains Rider either uses interpolated string or String.Format(). Note that you can always convert between those with context actions Alt+Enter.

In the example below, this command is used to generate the ToString() method based on _radius and _center fields.

Before generation

After generation

class Circle { int _radius; Point _center; }
class Circle { int _radius; Point _center; public override string ToString() { return $"{nameof(_radius)}: {_radius}, {nameof(_center)}: {_center}"; } }

Generate overrides for formatting members

  1. In the editor, place the caret at the type name or within a type at the line where you want to insert overrides for formatting members. If the caret is on the type name, the generated code will be added in the beginning of the type declaration.

  2. Press Alt+Insert or choose Code | Generate... from the main menu. Alternatively, you can press Ctrl+Shift+A, start typing the command name in the popup, and then choose it there.

  3. In the Generate popup, select Formatting Members.

  4. In the Generate dialog that appears, select fields and/or auto-properties to be used in the ToString() override.

    Generating 'ToString()' with JetBrains Rider

    If there are no fields/properties in your type or you do not select any of them, JetBrains Rider, depending on your settings, throws new NotImplementedException(), returns default value, or puts code that will not compile in the body of the generated methods.

    Optionally, use the following controls in the dialog:

    • ToString already exists — appears if an implementation of ToString() already exists and lets you choose whether to:

      • Replace the method if it already exists.

      • Put the newly generated method side by side with the existing one.

      • Skip generating a new method altogether.

    • Use 'nameof' — appears if the target C# version is higher than 6.0. If this checkbox is selected, JetBrains Rider will use nameof(symbol_name) to define the string representation of the symbol, otherwise, it will calculate the string representation automatically, for example, a field named _radius will be rendered as "Radius".

  5. Click OK to complete the wizard.

You can also generate the override by choosing Overriding Members in the Generate menu, but in this case the override will return base.ToString().

Last modified: 26 May 2024