Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 19, 2025

Enhanced the documentation for DebuggerDisplayAttribute properties (Value, Name, and Type) by adding information about format specifiers and links to the Visual Studio debugger format specifier documentation.

Changes Made

  • Value property: Enhanced existing remarks with comprehensive documentation about curly braces, field/property/method evaluation, and format specifiers, including a link to the format specifier syntax documentation
  • Name property: Expanded the existing curly brace documentation to include format specifier information and added the documentation link
  • Type property: Replaced "To be added" placeholder with complete documentation about curly braces and format specifiers, including the documentation link

All three properties now link to /visualstudio/debugger/format-specifiers-in-csharp for detailed syntax information, making it easier for developers to understand how to format debugger display strings.

Example Impact

Before: Users had to search for format specifier syntax documentation elsewhere.

After: Users can directly access format specifier documentation from each property's documentation page, learning about syntax like:

  • {fieldName} - displays field value
  • {propertyName,nq} - displays property value without quotes
  • {methodName()} - calls and displays method result

Fixes #11288.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@Copilot Copilot AI changed the title [WIP] There should be a link to syntax of string parameter Add format specifier documentation links to DebuggerDisplayAttribute properties Jun 19, 2025
Copilot finished work on behalf of jeffhandley June 19, 2025 06:57
@Copilot Copilot AI requested a review from jeffhandley June 19, 2025 06:57
@jeffhandley jeffhandley marked this pull request as ready for review June 19, 2025 07:19
@jeffhandley jeffhandley requested a review from a team as a code owner June 19, 2025 07:19
@gewarren gewarren closed this Jun 19, 2025
@gewarren gewarren reopened this Jun 19, 2025
@jeffhandley jeffhandley merged commit 037167b into main Jun 20, 2025
7 of 8 checks passed
@jeffhandley jeffhandley deleted the copilot/fix-11288 branch June 20, 2025 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

There should be a link to syntax of string parameter
3 participants