Utilizar el atributo DebuggerDisplay

Este tema se aplica a:

Edición	Visual Basic	C#	F#	C++	Web Developer
Express
Pro, Premium y Ultimate

El atributo DebuggerDisplay (System.Diagnostics.DebuggerDisplayAttribute) controla la forma en que se muestra una clase o un campo en las ventanas de variables del depurador. Este atributo se puede aplicar a:

• Clases

• Structs

• Delegados

• Enumeraciones

• Campos

• Propiedades

• Ensamblados

El atributo DebuggerDisplay tiene un argumento único, que es una cadena que se va a mostrar en la columna de valor para las instancias del tipo. Esta cadena puede contener llaves ({ y }). El texto entre un par de llaves se evaluará como un campo, una propiedad o un método.

Si un objeto de C# tiene un método ToString() invalidado, el depurador llamará al objeto invalidado y mostrará su resultado en lugar del {<typeName>} estándar. Por lo tanto, si ha invalidado ToString(), no tendrá que utilizar DebuggerDisplay. Si utiliza ambos, el atributo DebuggerDisplay tiene prioridad sobre el reemplazo de ToString().

La evaluación de la llamada implícita a ToString() por parte del depurador depende de un valor de configuración del usuario en el cuadro de diálogo Opciones (categoría Depuración, página General). Visual Basic no implementa esta evaluación implícita de ToString().

Importante
Si la casilla Mostrar la estructura de los objetos en ventanas de variables está seleccionada en el cuadro de diálogo Herramientas - Opciones, se omite el atributo DebuggerDisplay.

En la tabla siguiente se muestran algunos posibles usos del atributo DebuggerDisplay y resultados de ejemplo.

Atributo	Resultado que aparece en la columna Valor
[DebuggerDisplay("x = {x} y = {y}")] Se utiliza en un tipo con campos x y y.	x = 5 y = 18
[DebuggerDisplay("String value is {getString()}")] La sintaxis de los parámetros puede variar según el lenguaje. Por consiguiente, utilícela con cuidado.	String value is [5, 6, 6]

DebuggerDisplay también puede aceptar parámetros con nombre.

Parámetros	Finalidad
Name, Type	Estos parámetros afectan a las columnas Nombre y Tipo de las ventanas de variables. (Se pueden establecer en cadenas utilizando la misma sintaxis que el constructor.) El uso excesivo o incorrecto de estos parámetros puede generar resultados confusos.
Target, TargetTypeName	Especifica el tipo de destino cuando se utiliza el atributo en el nivel de ensamblado.

Nota

El archivo autoexp.cs usa el atributo DebuggerDisplay en el nivel de ensamblado. El archivo autoexp.cs determina las expansiones predeterminadas que Visual Studio utiliza para variables de C#. Puede examinar el archivo autoexp.cs para ver ejemplos de cómo utilizar el atributo DebuggerDisplay, o puede modificar y compilar el archivo autoexp.cs para cambiar las expansiones predeterminadas. Asegúrese de hacer un copia de seguridad del archivo autoexp.cs antes de modificarlo. Debe hacer referencia a Microsoft.VisualStudio.DebuggerVisualizers.dll en \Archivos de programas\Microsoft Visual Studio 10.0\Common7\IDE\PublicAssemblies. Puede encontrar el archivo autoexp.cs en Mis documentos/Visual Studio 10.0/Visualizers.

Uso de expresiones en DebuggerDisplay

Aunque puede utilizar una expresión general entre llaves en un atributo DebuggerDisplay, esta práctica no se recomienda.

Una expresión general en DebuggerDisplay tiene acceso implícito al puntero this sólo para la instancia actual del tipo de destino. La expresión no tiene acceso a los alias, variables locales ni punteros. Si la expresión hace referencia a propiedades, no se procesan los atributos en esas propiedades. Por ejemplo, el código [DebuggerDisplay("Object {count - 2}" de C# presentaría Object 6 si el campo count fuera 8.

El uso de expresiones en DebuggerDisplay puede generar los problemas siguientes:

• La evaluación de expresiones es la operación más costosa del depurador y la expresión se evalúa cada vez que se muestra. Esto puede causar problemas de rendimiento al recorrer el código. Por ejemplo, una expresión compleja que se usa para mostrar los valores de una colección o lista puede ser muy lenta si incluye un número elevado de elementos.

• Las expresiones las evalúa el evaluador de expresiones del lenguaje del marco de pila actual, no el evaluador del lenguaje en el que se escribió la expresión. Esto puede provocar resultados imprevisibles cuando los lenguajes son distintos.

• La evaluación de una expresión puede cambiar el estado de la aplicación. Por ejemplo, una expresión que establece el valor de una propiedad muta el valor de propiedad en el código que se está ejecutando.

Una forma de reducir los posibles problemas de la evaluación de expresiones es crear una propiedad privada que realiza la operación y devuelve una cadena. A continuación, el atributo DebuggerDisplay puede mostrar el valor de dicha propiedad privada. En el ejemplo siguiente se implementa este modelo:

[DebuggerDisplay("{DebuggerDisplay,nq}")]
public sealed class MyClass {
    public int count { get; set; }
    public bool flag { get; set; }
    private string DebuggerDisplay {
        get{ return string.Format("("Object {0}", count - 2); }
    }
}

Ejemplo

En el ejemplo de código siguiente se muestra cómo utilizar DebuggerDisplay, junto con DebuggerBrowseable y DebuggerTypeProxy. Cuando se ve en una ventana de variables del depurador, como la ventana Inspección, genera una expansión similar a la que sigue:

Name	Valor	Tipo
Clave	"three"	object {string}
Valor	3	object {int}

[DebuggerDisplay("{value}", Name = "{key}")]
internal class KeyValuePairs
{
    private IDictionary dictionary;
    private object key;
    private object value;
    public KeyValuePairs(IDictionary dictionary, object key, object value)
    {
        this.value = value;
        this.key = key;
        this.dictionary = dictionary;
    }

    public object Key
    {
        get { return key; }
        set
        {
            object tempValue = dictionary[key];
            dictionary.Remove(key);
            key = value;
            dictionary.Add(key, tempValue);
        }
    }

    public object Value
    {
        get { return this.value; }
        set
        {
            this.value = value;
            dictionary[key] = this.value;
        }
    }
}

[DebuggerDisplay("{DebuggerDisplay,nq}")]
[DebuggerTypeProxy(typeof(HashtableDebugView))]
class MyHashtable
{
    public Hashtable hashtable;

    public MyHashtable()
    {
        hashtable = new Hashtable();  
    }

    private string DebuggerDisplay
    {
        get { return "Count = " + hashtable.Count); }
    }

    private class HashtableDebugView
    {
        private MyHashtable myhashtable;
        public HashtableDebugView(MyHashtable myhashtable)
        {
            this.myhashtable = myhashtable;
        }

        [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
        public KeyValuePairs[] Keys
        {
            get
            {
                KeyValuePairs[] keys = new KeyValuePairs[myhashtable.hashtable.Count];

                int i = 0;
                foreach (object key in myhashtable.hashtable.Keys)
                {
                    keys[i] = new KeyValuePairs(myhashtable.hashtable, key, myhashtable.hashtable[key]);
                    i++;
                }
                return keys;
            }
        }
    }
}

Vea también

Referencia

Utilizar el atributo DebuggerTypeProxy

Conceptos

Mostrar tipos de datos personalizados

Mejorar la depuración con los atributos de visualización del depurador

Historial de cambios

Fecha	Historial	Motivo
Mayo de 2011	Se agregaron precauciones sobre el uso de las expresiones en los valores de atributo.	Mejora de la información.