Jorge Serrano
  • Home

Uso de DebuggerBrowsable

  • By jorge
  • Jun-21-2014
  • Sin categoría
  • 1 Comment.

Introducción

Sé que hay gente que sigue la máxima de la información es poder, y de obtener información y conocimiento de muchos sitios y no compartir nada con el resto, algo que respeto pero que no comparto, ya que entre todos podemos recorrer más camino que uno sólo.

Pero lo mejor de todo es que no estoy sólo en ese camino, y me uno al grupo de entusiastas y apasionados de la tecnología que piensan igual que yo.

El caso es que recientemente, dos de esos apasionados escribieron en sus blogs un par de entradas precedidas antes por Twitter y a la que siguieron algunos comentarios muy interesantes.

En la primera de ellas, Luis Ruiz Pavón nos habló de como sobreescribir ToString en nuestras clases para mejorar la información en modo de depuración.

Otro fenómeno como es Eduard Tomás, complementó aquella entrada con otra no menos excelente titulada TIP – DebuggerDisplay.

Lo bueno es que leyendo estas entradas, uno reflexiona, piensa y recuerda, como así ha sido el caso, de la existencia de otras clases, en este caso de DebuggerBrowsable, del que quiero hablar aquí, y cuya existencia pasa muchas veces desapercibida para los desarrolladores, pero que creo complementa a las dos excelentes entradas de Luis y Eduard.

El objetivo de la depuración

El objetivo principal de la depuración es el de preguntar o interrogar como se están comportando nuestros procesos y nuestros objetos, sus flujos y qué información va y viene.

El problema a veces, es que manejamos gran cantidad de información en pantalla que nos impide ver con relativa facilidad algunos miembros o variables. Dicho de otro modo, hay miembros y variables cuya información no nos resulta relevante y… nos estorba cuando estamos depurando.

Por suerte, dentro de .NET tenemos la posibilidad de utilizar un atributo, de nombre DebuggerBrowsable, que nos permite ocultar o mostrar un nivel por encima aquellos miembros que nos interesa ver de un vistazo rápido.

La mejor manera de comprender esto bien, es haciendo un ejemplo, así que nos pondremos manos a la obra con C#.

Entendiendo el problema

En primer lugar, mostraremos el problema para posteriormente resolverlo.

Iniciaremos un proyecto de WinForms (aunque puede ser cualquier otro).

Crearemos dentro de él, dos clases. Una clase de nombre Team, y otra clase de nombre Driver.

Serán dos clases muy sencillas.

La primera clase Team tendrá el siguiente código:

namespace WindowsFormsApplication1

{

    public class Team

    {

 

        public string TeamName { get; set; }

        public string Country { get; set; }

        public Driver Name { get; set; }

    }

}

La segunda clase Driver tendrá el siguiente código:

namespace WindowsFormsApplication1

{

    public class Driver

    {

        public string Name { get; set; }

        public string Surname { get; set; }

        public byte Age { get; set; }

    }

}

Como podemos observar, son dos clases muy sencillas.

La primera corresponde a los datos de un equipo de Formula1, y la segunda contiene los datos de su primer piloto, con su nombre, apellido y edad.

Por su parte, nuestro formulario Windows contendrá el siguiente código fuente:

namespace WindowsFormsApplication1

{

    public partial class MainForm : Form

    {

 

        public MainForm()

        {

            InitializeComponent();

            Initialize();

        }

 

        private Team Formula1Team { get; set; }

 

        private void MainForm_Load(object sender, EventArgs e)

        {            

        }

 

        private void Initialize()

        { 

            this.Formula1Team = new Team() { TeamName = "Ferrari", 

                                             Country = "Italy", 

                                             Name = new Driver() 

                                                    { 

                                                        Name = "Fernando", 

                                                        Surname = "Alonso", 

                                                        Age = 32 

                                                     } 

                                            };

        }

 

    }

}

A continuación, pondremos un punto de interrupción después de agregar un objeto de tipo Team a Formula1Team y veremos la información que nos devuelve el depurador al posicionarnos encima de la propiedad Formula1Team.

La primera información que veremos en la que se indica en la siguiente imagen:

Algo que a todas luces es correcto.

Sin embargo, si queremos acceder a Name, observamos que es del tipo Driver, y nos obliga a hacer clic sobre Name para ver el contenido de esta clase:

El problema aquí es que hemos realizado dos pasos hasta llegar a parte de la información que nos interesaba.

¿Cómo resolver esto?. ¿Tenemos alguna manera de obtener la información que deseamos de un solo plumazo en el visualizador de depuración?.

La respuesta nos la da DebuggerBrowsable, el cual aún no hemos utilizado.

Entendiendo DebuggerBrowsable

Una vez que entendemos un poco la problemática (no en todos los proyectos nos encontraremos con esta problemática o con la necesidad que he expuesto como ejemplo), vamos a ver como resolverlo. Para ello, utilizaremos el atributo DebuggerBrowsable.

Este atributo pertenece al namespace System.Diagnostics, y puede ser agregado a propiedades y campos en clases y estructuras.

Por su parte, tiene tres valores enumerados posibles pertenecientes a DebuggerBrowsableState que son:

  • Collapsed: muestra el objeto contraído, pero permite visualizar el miembro y expandirlo con el objetivo de acceder a cualquier otro miembro que lo pueda contener.
  • Never: no muestra nunca el elemento.
  • RootHidden: oculta el elemento raiz, mostrando los elementos secundarios en el caso de que el elemento sea una colección o matriz de elementos.

Un detalle de este uso es que podemos combinar estos atributos dentro de las diferentes clases. En el ejemplo anterior, tenemos un objeto de tipo Team que contiene a su vez datos de tipo Driver.

En nuestro caso, lo que nos interesa es mostrar en el depurador la información del nombre del equipo y el nombre y apellido del piloto principal del equipo.

Empezaremos por el final.

El objetivo es que el depurador nos muestre una información similar a la que se indica a continuación:

Como podemos observar, lo que obtenemos por pantalla en nuestro caso, es más relevante y nos ayuda a centrarnos en la información que consideramos clave o más importante a la hora de depurar.

El código de nuestras clases Team y Driver, quedarán de la siguiente manera en este caso:

La clase Team quedará de la siguiente forma:

using System.Diagnostics;

 

namespace WindowsFormsApplication1

{

    public class Team

    {

 

        public string TeamName { get; set; }

        [DebuggerBrowsable(DebuggerBrowsableState.Never)]

        public string Country { get; set; }

        [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]

        public Driver Name { get; set; }

    }

}

La clase Driver quedará de la siguiente forma:

using System.Diagnostics;

 

namespace WindowsFormsApplication1

{

    public class Driver

    {

        public string Name { get; set; }

        public string Surname { get; set; }

        [DebuggerBrowsable(DebuggerBrowsableState.Never)]

        public byte Age { get; set; }

    }

}

Obviamente, el resto de miembros del objeto está ahí y no han desaparecido. El Intellisense los localiza sin problemas y podemos acceder a ellos desde código.

Sin embargo y como podemos apreciar, el uso de este atributo nos puede venir bien en diferentes situaciones. Ahí cada uno debe saber si le aporta valor o no.

Comments

One Responseso far

  1. anonymous dice:
    23 septiembre, 2014 a las 12:51 pm

    Uso de DebuggerBrowsable – Jorge Serrano – MVP Visual Developer – Visual Basic

    Responder

Deja un comentario Cancelar respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

← Previous Post Next Post →

Jorge Serrano

MVP Reconnect


¡Subscríbete a mi canal!
YouTube

Donaciones
Donation

Entradas recientes

  • Go – Arrays
  • Go – Operators
  • Go – Constants
  • Go – Tipos de Datos
  • Go – Variables
  • Hello Go-rld!
  • Introducción a Go o Golang
  • JSON Patch en ASP.NET Core 5 Web API
  • Null Checking en C#
  • ¿Porqué mi página web por defecto de ASP.NET Core no se vé en mi Azure Web App y me da un 404?

Categorías

  • .NET 5
  • .NET Core
  • .NET Core 3.0
  • .NET Core 3.1
  • .NET Framework 2.0
  • .NET Framework 3.0
  • .NET Framework 3.5
  • .NET Framework 4.0
  • .NET Framework 4.5
  • .NET Framework 4.6
  • .NET Framework 4.7
  • .NET Framework 4.8
  • .NET Standard 2.0
  • .NET Standard 2.1
  • AMQP
  • Android
  • Angular
  • API REST
  • Apple
  • Apple iOS
  • Apple macOs
  • Arquitectura
  • ASP.NET
  • ASP.NET Core
  • ASP.NET Core 3
  • ASP.NET Core 5
  • AWS
  • Azure App Service
  • Azure Application Insights
  • Azure Cosmos DB
  • Azure Database Migration Service
  • Azure Databricks
  • Azure DevOps
  • Azure Event Grid
  • Azure Functions
  • Azure IoT
  • Azure Portal
  • Azure PowerShell
  • Azure Queue Storage
  • Azure SQL
  • Azure Storage
  • Azure Virtual Datacenter
  • Azure WebApps
  • Big Data
  • Bing
  • Blazor
  • Blog
  • Bots
  • C#
  • C# 7.0
  • C# 7.1
  • C# 7.2
  • C# 7.3
  • C# 8.0
  • C# 9.0
  • Channel 9
  • Codeplex
  • Codespaces
  • Containers
  • Debugging
  • DevOps
  • Docker
  • Electron
  • Entity Framework
  • Entity Framework Core
  • Entity Framework Core 3.0
  • Entity Framework Core 5
  • Eventos
  • F#
  • FaaS
  • FeatureFlags
  • FeatureToggles
  • Feeds
  • Fluent Assertions
  • General
  • GIMP
  • Git
  • GitHub
  • Go
  • Google
  • Google Analytics
  • Gradle
  • gRPC
  • GSA
  • Historia de la Informática
  • HoloLens
  • HtmlAgilityPack
  • IdentityServer4
  • Inkscape
  • Ionic
  • iOS
  • IoT
  • Java
  • JavaScript
  • JDBC
  • JSON
  • Kubernetes
  • Lenguajes de Programación
  • Libros y Cursos
  • LINQ
  • Linux
  • LiteDB
  • Machine Learning
  • macOS
  • Microservices
  • Microsoft
  • Microsoft .NET Framework 4.5
  • Microsoft 365
  • Microsoft Azure
  • Microsoft Build
  • Microsoft Ignite
  • Microsoft Learn
  • Microsoft Orleans
  • Microsoft Surface Go
  • Microsoft Teams
  • ML.NET
  • MQTT
  • MRO
  • MS-DOS
  • MsCoders Madrid
  • MVP
  • NancyFx
  • Node.js
  • NoSQL
  • NuGet
  • NUnit
  • OData
  • ODP.NET Core
  • Office 2007
  • Office 2010
  • Office 2013
  • Office 2016
  • Office 2019
  • Office 365
  • Open Source
  • Open XML SDK
  • Opinión
  • Orchard CMS
  • OT
  • PaaS
  • Patterns
  • PdfSharpCore
  • Performance
  • PHP
  • Postman
  • Power BI
  • PowerShell
  • PowerShell Core
  • Productividad
  • Project Server 2019
  • R
  • Rendimiento
  • Scala
  • Scraper
  • Security
  • Serverless
  • Service Fabric
  • SharePoint Server 2019
  • SignalR
  • Sin categoría
  • Sistemas Distribuidos
  • Skype
  • Skype for Business Server 2019
  • Small Basic Online
  • SQL Server 2005
  • SQL Server 2008
  • SQL Server 2012
  • SQL Server 2014
  • SQL Server 2016
  • SQL Server 2017
  • SQL Server 2019
  • STOMP
  • Swagger
  • Testing
  • TFS 2017
  • TFS 2018
  • Tools
  • TypeScript
  • Unity
  • UWP
  • UX
  • Visio
  • Visual Basic
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013
  • Visual Studio 2015
  • Visual Studio 2017
  • Visual Studio 2017 for Mac
  • Visual Studio 2019
  • Visual Studio 2019 for Mac
  • Visual Studio App Center
  • Visual Studio Code
  • Visual Studio IntelliCode
  • Visual Studio Live Share
  • Visual Studio Live Share Audio
  • Visual Studio Online
  • VS Anywhere
  • Vue.js
  • Web API
  • WebAssembly
  • WinDbg
  • Windows
  • Windows 10
  • Windows Compatibility Pack
  • Windows Phone 10
  • Windows Phone 7
  • Windows Phone 8
  • Windows Server 2008
  • Windows Server 2012
  • Windows Server 2016
  • Windows Server 2019
  • Windows Service
  • WinForms
  • WinUI
  • WPF
  • Xamarin
  • Xbox
  • Xcode
  • Xiaomi Mi Band 2
  • xUnit
  • YAML

Archivos

  • enero 2021
  • diciembre 2020
  • noviembre 2020
  • octubre 2020
  • septiembre 2020
  • agosto 2020
  • julio 2020
  • junio 2020
  • mayo 2020
  • abril 2020
  • marzo 2020
  • febrero 2020
  • enero 2020
  • diciembre 2019
  • noviembre 2019
  • octubre 2019
  • septiembre 2019
  • agosto 2019
  • julio 2019
  • junio 2019
  • mayo 2019
  • abril 2019
  • marzo 2019
  • febrero 2019
  • enero 2019
  • diciembre 2018
  • noviembre 2018
  • octubre 2018
  • septiembre 2018
  • agosto 2018
  • julio 2018
  • junio 2018
  • mayo 2018
  • abril 2018
  • marzo 2018
  • febrero 2018
  • enero 2018
  • diciembre 2017
  • noviembre 2017
  • octubre 2017
  • septiembre 2017
  • agosto 2017
  • julio 2017
  • junio 2017
  • febrero 2015
  • octubre 2014
  • junio 2014
  • marzo 2014
  • febrero 2014
  • enero 2014
  • diciembre 2013
  • septiembre 2013
  • agosto 2013
  • julio 2013
  • junio 2013
  • abril 2013
  • febrero 2013
  • enero 2013
  • diciembre 2012
  • noviembre 2012
  • septiembre 2012
  • agosto 2012
  • junio 2012
  • mayo 2012
  • abril 2012
  • marzo 2012
  • febrero 2012
  • enero 2012
  • diciembre 2011
  • noviembre 2011
  • octubre 2011
  • septiembre 2011
  • agosto 2011
  • julio 2011
  • junio 2011
  • mayo 2011
  • abril 2011
  • marzo 2011
  • enero 2011
  • diciembre 2010
  • noviembre 2010
  • octubre 2010
  • septiembre 2010
  • agosto 2010
  • julio 2010
  • junio 2010
  • mayo 2010
  • abril 2010
  • marzo 2010
  • febrero 2010
  • enero 2010
  • diciembre 2009
  • noviembre 2009
  • octubre 2009
  • septiembre 2009
  • agosto 2009
  • julio 2009
  • junio 2009
  • mayo 2009
  • abril 2009
  • marzo 2009
  • febrero 2009
  • enero 2009
  • diciembre 2008
  • noviembre 2008
  • octubre 2008
  • septiembre 2008
  • agosto 2008
  • julio 2008
  • junio 2008
  • mayo 2008
  • abril 2008
  • marzo 2008
  • febrero 2008
  • enero 2008
  • diciembre 2007
  • noviembre 2007
  • octubre 2007
  • septiembre 2007
  • agosto 2007
  • julio 2007
  • junio 2007
  • mayo 2007
  • abril 2007
  • marzo 2007
  • febrero 2007
  • enero 2007
  • diciembre 2006
  • noviembre 2006
  • octubre 2006
  • septiembre 2006
  • agosto 2006
  • julio 2006
  • junio 2006
  • mayo 2006
About This Site

A cras tincidunt, ut tellus et. Gravida scel ipsum sed iaculis, nunc non nam. Placerat sed phase llus, purus purus elit.

Archives Widget
  • January 2010
  • December 2009
  • November 2009
  • October 2009
Categories
  • Entertainment
  • Technology
  • Sports & Recreation
  • Jobs & Lifestyle
Search
  • twitter

Powered by WordPress  |  Business Directory by InkThemes.

This site uses cookies: Find out more.