Gibt es eine Methode zum Rendern eines Objekts mit DebuggerDisplayAttribute

Question

Ich habe eine Reihe von Klassen, die mit DebuggerDisplayAttribute geschmückt sind.

Ich möchte Trace-Anweisungen zu Unit Tests hinzufügen, die Instanzen dieser Klassen angezeigt werden.

Gibt es in .NET Framework eine Methode, die ein Objekt anzeigt, das mit DebuggerDisplayAttribute formatiert wurde (oder auf die Verwendung von .ToString() zurückgreift, wenn kein DebuggerDisplayAttribute definiert ist)?

EDIT

Um zu klären, ich war es etwas in das Framework integriert sein könnte hoffen. Ich weiß, dass ich die Value-Eigenschaft von DebuggerDisplayAttribute abrufen kann, aber ich muss dann meine Instanz formatieren, indem ich die Formatzeichenfolge verwendet, die von DebuggerDisplayAttribute.Value dargestellt wird.

Wenn ich meine eigene Rolle, würde ich eine Verlängerung Methode entlang der folgenden Zeilen ins Auge fassen:

public string FormatDebugDisplay(this object value) 
{ 
    DebugDisplayAttribute attribute = ... get the attribute for value ... 
    if (attribute = null) return value.ToString(); 

    string formatString = attribute.Value; 

    ??? How do I format value using formatString ??? 
    return SomeFormatMethod(formatString, value); 
} 

Answer 1

Das mag schön sein - aber der Formatstring des DebuggerDisplayAttribute wird vom Debugger ausgewertet, genauso wie er Ausdrücke auswertet, die Sie in die Beobachtungsfenster eingeben. O r das Direktfenster. Aus diesem Grund können Sie beliebige Ausdrücke in die geschweiften Klammern einfügen, z. B. {FirstName + " " + LastName}.

Daher, um diese in Ihrem Code zu bewerten, müssten Sie den Visual Studio-Debugger in Ihre App einbetten. Wahrscheinlich wird es nicht passieren. (grinsen)

Ihre beste Wette ist wahrscheinlich, um alle Formatierungslogik, die derzeit in Ihrem DebuggerDisplay Format Zeichenfolge ist, und machen Sie es stattdessen eine Methode. Dann können Sie diese Methode aus Ihrem Code heraus aufrufen. Ihr DebuggerDisplay-Attribut beendet nichts anderes als die Methode aufzurufen.

[DebuggerDisplay("{Inspect()}")] 
public class MyClass { 
    public string Inspect() { ... } 
} 

Answer 2

Die DebuggerDisplayAttribute hat eine Value Eigenschaft, die zurückgibt, was Sie wollen.

So könnte man wohl so etwas wie folgt verwenden:

var attribute = obj.GetType(). 
    GetCustomAttributes(typeof(DebuggerDisplayAttribute), false); 
return (attribute == null) ? obj.ToString() : attribute.Value; 

Man könnte sogar diese in eine Erweiterung Methode setzen:

public static string ToDebugString(this object obj) 
{ 
    var attribute = obj.GetType(). 
     GetCustomAttributes(typeof(DebuggerDisplayAttribute), false); 
    return (attribute == null) ? obj.ToString() : attribute.Value; 
} 

das Sie es auf jedem Objekt aufrufen kann: myObject.ToDebugString()

Answer 3

Diese Methode wird nicht genau das umzusetzen, was DebuggerDisplayAttribute im Debugger bietet, aber das ist, was ich in meinem Code im Einsatz. Es deckt ungefähr 90% (oder mehr) der Fälle ab, die wir in unserer Codebasis erleben. Wenn Sie es reparieren, um noch mehr Fälle zu decken, würde ich gerne Ihre Verbesserungen sehen!

public static string ToDebuggerString(this object @this) 
    { 
     var display = @this.GetType().GetCustomAttributes(typeof (DebuggerDisplayAttribute),false).FirstOrDefault() as DebuggerDisplayAttribute; 
     if (display == null) 
      return @this.ToString(); 

     var format = display.Value; 
     var builder = new StringBuilder(); 
     for (var index = 0; index < format.Length; index++) 
     { 
      if (format[index] == '{') 
      { 
       var close = format.IndexOf('}', index); 
       if (close > index) 
       { 
        index++; 
        var name = format.Substring(index, close - index); 
        var property = @this.GetType().GetProperty(name); 
        if (property != null) 
        { 
         var value = property.GetValue(@this, null).ToString(); 
         builder.Append(value); 
         index += name.Length; 
        } 
       } 
      } 
      else 
       builder.Append(format[index]); 
     } 
     return builder.ToString(); 
    }