c# - 是什么让 Visual Studio 调试器停止评估 ToString 覆盖？

Question

环境:Visual Studio 2015 RTM。 (我没有尝试过旧版本。)

最近，我一直在调试我的一些 Noda Time代码，我注意到当我有一个类型为 NodaTime.Instant 的局部变量时(野田时间的中央 struct 类型之一)，“Locals”和“Watch”窗口似乎不会调用它的 ToString()覆盖。如果我打电话ToString()在监视窗口中明确显示，我看到了适当的表示，但除此之外我只看到:

variableName       {NodaTime.Instant}

这不是很有用。

如果我更改覆盖以返回一个常量字符串，该字符串将显示在调试器中，因此它显然能够发现它在那里——它只是不想在“正常”状态下使用它。

我决定在一个小演示应用程序中在本地重现这个，这就是我想出的。 (请注意，在这篇文章的早期版本中， DemoStruct 是一个类，而 DemoClass 根本不存在 - 我的错，但它解释了一些现在看起来很奇怪的评论......)

using System;
using System.Diagnostics;
using System.Threading;

public struct DemoStruct
{
    public string Name { get; }

    public DemoStruct(string name)
    {
        Name = name;
    }

    public override string ToString()
    {
        Thread.Sleep(1000); // Vary this to see different results
        return $"Struct: {Name}";
    }
}

public class DemoClass
{
    public string Name { get; }

    public DemoClass(string name)
    {
        Name = name;
    }

    public override string ToString()
    {
        Thread.Sleep(1000); // Vary this to see different results
        return $"Class: {Name}";
    }
}

public class Program
{
    static void Main()
    {
        var demoClass = new DemoClass("Foo");
        var demoStruct = new DemoStruct("Bar");
        Debugger.Break();
    }
}

在调试器中，我现在看到:

demoClass    {DemoClass}
demoStruct   {Struct: Bar}

但是，如果我减少 Thread.Sleep调用从 1 秒到 900 毫秒，仍然有短暂的停顿，但随后我看到了 Class: Foo作为值(value)。 Thread.Sleep 持续多久似乎无关紧要电话在 DemoStruct.ToString() ，它总是正确显示 - 并且调试器在 sleep 完成之前显示该值。 (就好像 Thread.Sleep 被禁用了。)

现在 Instant.ToString()在 Noda Time 中做了相当多的工作，但它肯定不会花费一整秒——所以大概有更多的条件导致调试器放弃评估 ToString()称呼。当然，无论如何它都是一个结构体。

我尝试递归查看是否是堆栈限制，但似乎并非如此。

那么，我如何才能弄清楚是什么阻止了 VS 全面评估 Instant.ToString() ?如下所述， DebuggerDisplayAttribute似乎有帮助，但不知道为什么，我永远不会对何时需要和何时不需要完全有信心。

更新

如果我使用 DebuggerDisplayAttribute ， 事情会改变的:

// For the sample code in the question...
[DebuggerDisplay("{ToString()}")]
public class DemoClass

给我:

demoClass      Evaluation timed out

而当我在野田时间应用它时:

[DebuggerDisplay("{ToString()}")]
public struct Instant

一个简单的测试应用程序向我展示了正确的结果:

instant    "1970-01-01T00:00:00Z"

所以想必野田时间的问题是 DebuggerDisplayAttribute的一些条件确实强制通过 - 即使它不强制通过超时。 (这符合我的预期，即 Instant.ToString 足够快以避免超时。)

这可能是一个足够好的解决方案 - 但我仍然想知道发生了什么，以及我是否可以简单地更改代码以避免必须将属性放在 Noda Time 中的所有各种值类型上。

越来越好奇

任何让调试器感到困惑的东西只是有时会让它感到困惑。让我们创建一个包含 Instant 的类并将其用于自己的 ToString()方法:

using NodaTime;
using System.Diagnostics;

public class InstantWrapper
{
    private readonly Instant instant;

    public InstantWrapper(Instant instant)
    {
        this.instant = instant;
    }

    public override string ToString() => instant.ToString();
}

public class Program
{
    static void Main()
    {
        var instant = NodaConstants.UnixEpoch;
        var wrapper = new InstantWrapper(instant);

        Debugger.Break();
    }
}

现在我最终看到:

instant    {NodaTime.Instant}
wrapper    {1970-01-01T00:00:00Z}

但是，在 Eren 在评论中的建议下，如果我更改 InstantWrapper要成为一个结构，我得到:

instant    {NodaTime.Instant}
wrapper    {InstantWrapper}

所以它可以评估 Instant.ToString() - 只要它被另一个 ToString 调用方法......这是在一个类中。根据显示的变量的类型，类/结构部分似乎很重要，而不是代码需要什么
执行以获得结果。

作为另一个例子，如果我们使用:

object boxed = NodaConstants.UnixEpoch;

...然后它工作正常，显示正确的值。给我上色了。

Answer 1

更新:
此错误已在 Visual Studio 2015 Update 2 中修复。如果您在使用 Update 2 或更高版本对结构值评估 ToString 时仍然遇到问题，请告诉我。
原答案:
您遇到了 Visual Studio 2015 的已知错误/设计限制，并在结构类型上调用 ToString。这在处理 System.DateTimeSpan 时也可以观察到. System.DateTimeSpan.ToString()在 Visual Studio 2013 的评估窗口中有效，但在 2015 中并不总是有效。
如果你对底层细节感兴趣，这里是发生了什么:
评价ToString ，调试器执行所谓的“函数评估”。简单来说，调试器挂起进程中除当前线程之外的所有线程，将当前线程的上下文更改为ToString函数，设置一个隐藏的保护断点，然后允许进程继续。当保护断点被击中时，调试器将进程恢复到以前的状态，并使用函数的返回值来填充窗口。
为了支持 lambda 表达式，我们必须在 Visual Studio 2015 中完全重写 CLR 表达式评估器。 在较高级别上，实现是:

Roslyn 为表达式/局部变量生成 MSIL 代码，以获取要在各种检查窗口中显示的值。

调试器解释 IL 以获得结果。

如果有任何“调用”指令，调试器将执行
如上所述的功能评估。

调试器/roslyn 获取此结果并将其格式化为
向用户显示的树状 View 。

由于 IL 的执行，调试器总是处理“真实”和“虚假”值的复杂组合。实际值实际上存在于被调试的进程中。假值只存在于调试器进程中。为了实现正确的结构语义，在将结构值推送到 IL 堆栈时，调试器始终需要制作该值的副本。复制的值不再是“真实”值，现在只存在于调试器进程中。这意味着如果我们稍后需要执行 ToString 的函数评估，我们不能，因为该值在过程中不存在。为了尝试获取我们需要模拟 ToString 的执行的值方法。虽然我们可以模仿一些东西，但有很多限制。例如，我们无法模拟 native 代码，也无法执行对“真实”委托(delegate)值的调用或对反射值的调用。
考虑到所有这些，以下是导致您看到的各种行为的原因:

调试器不评估 NodaTime.Instant.ToString -> 这是
因为是struct类型，ToString的实现不能
由调试器模拟，如上所述。

Thread.Sleep被 ToString 调用时似乎需要零时间在一个
struct -> 这是因为模拟器正在执行 ToString .
Thread.Sleep 是 native 方法，但模拟器知道
它，只是忽略调用。我们这样做是为了尝试获得一个值
来展示给用户。在这种情况下，延迟将无济于事。

DisplayAttibute("ToString()")作品。 -> 这令人困惑。唯一的ToString的隐式调用的区别和DebuggerDisplay是隐式 ToString 的任何超时
评估将禁用所有隐式 ToString对此的评价
键入直到下一个调试 session 。你可能正在观察
行为。

就设计问题/错误而言，这是我们计划在 Visual Studio 的 future 版本中解决的问题。
希望这能解决问题。如果您有更多问题，请告诉我。 :-)