Indicar al depurador qué se va a mostrar mediante el atributo DebuggerDisplay (C#, Visual Basic, F#, C++/CLI)

  • Artículo

El atributo DebuggerDisplayAttribute controla la forma en que se muestra un objeto, una propiedad o un campo en las ventanas de variables del depurador. Este atributo se puede aplicar a tipos (clases, estructuras, enumeraciones, delegados). Si se aplica a un tipo base, el atributo también se aplica a una subclase.

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

Si una clase tiene un método ToString() invalidado, el depurador usa el método invalidado en lugar del atributo {<typeName>}predeterminado. Por lo tanto, si invalidó el método ToString(), el depurador usa el método invalidado en lugar del objeto {<typeName>} predeterminado y no tiene que usar DebuggerDisplay. Si usa ambos, el atributo DebuggerDisplay tiene prioridad sobre el método ToString() invalidado. El atributo DebuggerDisplay también tiene prioridad sobre el método ToString() invalidado en una subclase.

La evaluación de esta llamada implícita a ToString() por parte del depurador depende de un valor de configuración del usuario del cuadro de diálogo Herramientas/Opciones/Depuración.

Importante

Si la casilla Mostrar la estructura de los objetos en ventanas de variables está activada en el cuadro de diálogo Herramientas/Opciones/Depuración, se omite el atributo DebuggerDisplay.

Nota

En el caso de código nativo, este atributo solo se admite en código de C++/CLI.

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
La sintaxis del parámetro[DebuggerDisplay("String value is {getString()}")]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 Propósito
Name, Type Estos parámetros afectan a las columnas Nombre y Tipo de las ventanas de variables. (Se pueden establecer en cadenas mediante 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.

El archivo autoexp.cs usa el atributo DebuggerDisplay en el nivel de ensamblado. El archivo autoexp.cs determina las expansiones predeterminadas que usa Visual Studio para los objetos .NET. Puede examinar el archivo autoexp.cs para ver ejemplos de cómo usar 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.

Para compilar autoexp.cs, abra un Símbolo del sistema para desarrolladores para VS2015 y ejecute los siguientes comandos.

cd <directory containing autoexp.cs>
csc /t:library autoexp.cs

Los cambios de autoexp.dll se recogerán en la siguiente sesión de depuración.

Utilizar expresiones en DebuggerDisplay

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

Una expresión general en DebuggerDisplay tiene acceso implícito al puntero this solo 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 dichas 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 causar los siguientes problemas:

  • 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 la propiedad en el código en ejecución.

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

[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);
        }
    }
}

El sufijo ",nq" indica al evaluador de expresiones que quite las comillas al mostrar el valor final (nq = sin comillas).

Ejemplo

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

Name Valor Type
Key "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;
            }
        }
    }
}

Contenido relacionado