Skip to content

Generate DebuggerDisplayAttribute for API #194

Closed

Description

@TomFinley

DebuggerDisplayAttribute is a nice little thing to add to classes -- properly written, they make the debugger a bit less obnoxious to use by putting some important information about an instance front and center. At the same time, it would be nice if we could possibly avoid having to write all those ourselves, piecemeal.

CSharpApi.cs is geneated from the code in CSharpApiGenerator.cs. It may be a simple matter to enhance that code to attach a DebuggerDisplay attribute to the generated classes. The configuration objects have their properties and documentation derived from the ArgumentAttribute. We needn't display everything: In other contexts, we have distinguished important vs. more unimportant "advanced" parameters by ArgumentAttribute's SortOrder property. We could exploit that for this purpose as well, and only include in the display formatted string those parameters with that property set and of course only those types that would display well there anyway.

Activity

  1. veikkoeeva commented on May 21, 2018

    @veikkoeeva
    Contributor
  2. danmoseley commented on May 21, 2018

    @danmoseley

    Any interest in a contribution here @veikkoeeva ?

  3. veikkoeeva commented on May 22, 2018

    @veikkoeeva
    Contributor

    @danmosemsft Realistically on the first or second week of June I have more time. Unless it's OK to add attributes here and there, and someone giving places I haven't seen. But that could be someone else too, so let's not lock on me. :)

  4. danmoseley commented on May 22, 2018

    @danmoseley

    @veikkoeeva that would be welcome. I think that timeframe is fine. I'm sure @TomFinley can give pointers as required.

  5. jwood803 commented on Sep 22, 2018

    @jwood803
    Contributor

    @TomFinley Was just looking over this and I'm wondering, would the new API design impact this issue?

  6. codemzs commented on Jun 30, 2019

    @codemzs
    Member

    With the new API in place with debugger view support.

  7. ghost locked as resolved and limited conversation to collaborators on Mar 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions