如何在 Visual Studio 中生成包含所有属性的 ToString()？

Question

我是一名 Java 开发人员，习惯于 Eclipse 中的“生成 toString()”选项，该选项提供完整的 toString，打印所有实例变量的值。我只是在 Visual Studio 中寻找类似的快捷方式。

我已经看到如何开始输入方法，“公共覆盖”和自动完成将存根 ToString() 但它不会用所有类属性填充它。

    public override string ToString()
        {
            return base.ToString();
        }

我希望生成的方法包含类的所有属性。

Answer 1

你可以使用 JSON.NET 来序列化你的类。

public override string ToString()
{
    return JsonConvert.SerializeObject(this);
}

Answer 2

选项 1：反射

您可以通过使用反射来做到这一点。但是，如果您必须在短时间内频繁调用该方法，这可能会导致性能问题。使用反射进行编码也不是那么简单。

• Dynamic override of ToString() using Reflection
• How do I automatically display all properties of a class and their values in a string?

选项 2：锐化器

Visual Studio 插件 Resharper 具有此功能：

alt + 插入 -> 生成 -> 格式化成员 -> 全选 -> 完成

• https://www.jetbrains.com/help/resharper/Code_Generation__Formatting_Members.html

选项 3：Fody/ToString nuget 包

当您只需要公共属性时，这可能是最简单的解决方案。它不适用于公共字段。

• https://github.com/Fody/ToString

Answer 3

没有与您所说的 Java 和 Eclipse 相同的东西。

@RawitasKrungkaew 的回答很好。

如果你不想使用 JSON，可以使用反射和扩展方法来获得可重用性：

在某个班级

public override string ToString()
{
  return this.GetPropertiesAsText();
}

PropertiesListerHelper.cs

using System.Reflection;

static public class PropertiesListerHelper
{
  static private bool IsProcessing;

  static public string GetPropertiesAsText(this object instance)
  {
    if ( IsProcessing )
      return $"<Reentrancy in {instance.GetType().Name}.ToString()>";
    IsProcessing = true;
    try
    {
      string result = "";
      var list = instance.GetType().GetProperties().OrderBy(item => item.Name);
      foreach ( var property in list )
      {
        var value = property.GetValue(instance);
        result += $"{property.Name} = {(value == null ? "<null>" : value)}, ";
      }
      return result.TrimEnd(", ".ToArray());
    }
    catch ( Exception ex )
    {
      return $"<Exception in {instance.GetType().Name}.ToString(): {ex.Message}>";
    }
    finally
    {
      IsProcessing = false;
    }
  }
}

因此，即使类设计发生变化，该行为仍然有效。

您可以根据需要调整方法以格式化输出，例如：

foreach ( var property in list )
{
  var value = property.GetValue(instance);
  result += $"{property.Name} = {(value == null ? "<null>" : value)}"
          + Environment.NewLine;
}
return result.TrimEnd(Environment.NewLine.ToArray());

可能会改进对重入情况的管理，因为它可能会导致例如表单上的堆栈溢出。

Answer 4

答案中未提及的另一种方法是使用以下 Visual Studio 扩展：https://marketplace.visualstudio.com/items?itemName=DavideLettieri.AutoToString。安装扩展程序后，在类主体中点击 Ctrl + .，将会有额外的Generate ToString() 操作可用。

Answer 5

我不认为 Visual Studio 具有执行这种开箱即用的代码生成的操作。 但是，您可以使用 Visual Studio 的首选扩展来做到这一点：JetBrains Resharper。

它具有快速生成 ToString 的操作（以及许多其他功能）。

https://www.jetbrains.com/help/resharper/Code_Generation__Formatting_Members.html

Answer 6

默认情况下没有办法做到这一点 - 您在 Eclipse 中看到的是 Eclipse 的一个优点，而不是运行时的内置功能。您可以自己编写 VS 的扩展程序（查看我的评论），也可以使用扩展程序。我知道 Resharper offers the facility，但我必须强调，SO 不是“给我找一个可以做...的图书馆”服务，所以我不以任何方式对 Re# 提供任何认可或推荐

可能还值得指出：

1. 您可以在功能强大的文本编辑器中相对轻松地做到这一点
2. 您可以编写一个小应用程序，在将类复制到剪贴板时生成一个 tostring
3. 你可以放弃对它的渴望；在 c# 中，我们并没有真正像 java bod 那样广泛使用 ToString()，因为自从它首次发布以来，我们已经在 IDE 中内置了一个很棒的步进调试器。我们很少需要对我们的对象进行字符串化并将它们转储到命令行以随时检查程序对象的状态，因为我们可以暂停它并在 Locals 窗口等中查看它。如果您没有完全掌握速度调试器可以为您做的所有事情，我建议您观看一些视频

Answer 7

你可以这样做：

 public override string ToString()
 {
     return "First name: " + FirstName + ", Last name: " + LastName;
 }

或者更好的解决方案：

 public override string ToString()
 {
     return nameof(FirstName) + FirstName + ", " nameof(LastName) + LastName;
 }

如有必要，对属性使用强制转换。