Entorno: Visual Studio 2015 RTM. (No he probado versiones anteriores).
Recientemente, he estado depurando parte de mi código de Noda Time , y he notado que cuando tengo una variable local de tipo NodaTime.Instant
(uno de los struct
tipos centrales en Noda Time), las ventanas "Locals" y "Watch" no parece llamar a su ToString()
anulación. Si llamo ToString()
explícitamente en la ventana de observación, veo la representación apropiada, pero de lo contrario solo veo:
variableName {NodaTime.Instant}
lo cual no es muy útil
Si cambio la anulación para devolver una cadena constante, la cadena se muestra en el depurador, por lo que es claramente capaz de detectar que está allí, simplemente no quiere usarla en su estado "normal".
Decidí reproducir esto localmente en una pequeña aplicación de demostración, y esto es lo que se me ocurrió. (Tenga en cuenta que en una versión anterior de esta publicación, DemoStruct
era una clase y DemoClass
no existía en absoluto, es mi culpa, pero explica algunos comentarios que ahora parecen extraños ...)
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();
}
}
En el depurador, ahora veo:
demoClass {DemoClass}
demoStruct {Struct: Bar}
Sin embargo, si reduzco la Thread.Sleep
llamada de 1 segundo a 900 ms, todavía hay una breve pausa, pero luego veo Class: Foo
el valor. No parece importar cuánto tiempo Thread.Sleep
esté la llamada DemoStruct.ToString()
, siempre se muestra correctamente, y el depurador muestra el valor antes de que la suspensión se haya completado. (Es como si estuviera Thread.Sleep
deshabilitado).
Ahora Instant.ToString()
en Noda Time hace una buena cantidad de trabajo, pero ciertamente no lleva un segundo entero, por lo que presumiblemente hay más condiciones que hacen que el depurador deje de evaluar una ToString()
llamada. Y, por supuesto, es una estructura de todos modos.
He intentado recurrir para ver si es un límite de pila, pero ese no parece ser el caso.
Entonces, ¿cómo puedo averiguar qué impide que VS evalúe por completo Instant.ToString()
? Como se señala a continuación, DebuggerDisplayAttribute
parece ayudar, pero sin saber por qué , nunca tendré plena confianza en cuándo lo necesito y cuándo no.
Actualizar
Si lo uso DebuggerDisplayAttribute
, las cosas cambian:
// For the sample code in the question...
[DebuggerDisplay("{ToString()}")]
public class DemoClass
me da
demoClass Evaluation timed out
Mientras que cuando lo aplico en Noda Time:
[DebuggerDisplay("{ToString()}")]
public struct Instant
una aplicación de prueba simple me muestra el resultado correcto:
instant "1970-01-01T00:00:00Z"
Entonces, presumiblemente, el problema en Noda Time es alguna condición que DebuggerDisplayAttribute
se impone, a pesar de que no se impone durante los tiempos de espera. (Esto estaría en línea con mi expectativa de que Instant.ToString
sea lo suficientemente rápido como para evitar un tiempo de espera).
Esta puede ser una solución lo suficientemente buena, pero aún así me gustaría saber qué está pasando y si puedo cambiar el código simplemente para evitar tener que poner el atributo en todos los diversos tipos de valores en Noda Time.
Más curioso y más curioso
Lo que sea confuso para el depurador solo lo confunde a veces. Creemos una clase que contenga una Instant
y la use para su propio ToString()
método:
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();
}
}
Ahora termino viendo:
instant {NodaTime.Instant}
wrapper {1970-01-01T00:00:00Z}
Sin embargo, a sugerencia de Eren en los comentarios, si cambio InstantWrapper
para ser una estructura, obtengo:
instant {NodaTime.Instant}
wrapper {InstantWrapper}
Por lo tanto, puede evaluar Instant.ToString()
, siempre que sea invocado por otro ToString
método ... que está dentro de una clase. La parte de clase / estructura parece ser importante en función del tipo de variable que se muestra, no del código que debe ejecutarse para obtener el resultado.
Como otro ejemplo de esto, si usamos:
object boxed = NodaConstants.UnixEpoch;
... entonces funciona bien, mostrando el valor correcto. Coloreame confundido.
DebuggerDisplayAttribute
haría intentar un poco más duro.